9999: Generate Demo Dataset

Scenario #9999: Generate Demo Dataset

Create the mandant person Hostsharing eG

HTTP POST "/api/hs/office/persons" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY" \
  <<EOF
{
  "personType" : "LEGAL_PERSON",
  "tradeName" : "Hostsharing eG"
}
EOF
=> status: 201 CREATED 0ef98191-79d8-443e-89c1-1076e8f6df80

Creating accounts needs an acting global-admin USER subject, but that subject does not need to have an own account (and thus a person) itself. Here, such a subject gets created: it is synchronized from Keycloak, and the global ADMIN role is granted to it, but no account is created for it.

Properties

Given

name	value
subjectUuid	de300000-0000-0000-0000-000000000001
subjectName	hsh-demo_admin

Synchronize the new USER Subject from Keycloak

HTTP PUT "/api/rbac/subjects/de300000-0000-0000-0000-000000000001" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY" \
  <<EOF
{
  "name" : "hsh-demo_admin",
  "type" : "USER"
}
EOF
=> status: 201 CREATED de300000-0000-0000-0000-000000000001

This is what the Keycloak sync program does for each new Keycloak user.

Prerequisite: Resolve the UUID of the global ADMIN role

The grant API needs the UUID of the role which we want to grant.

HTTP GET "/api/rbac/roles?name=rbac.global%23global%3AADMIN" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY"
=> status: 200 OK 
[ {
  "uuid" : "3e03f781-3480-489e-bd5f-85954f8e419f",
  "object.uuid" : "fdfe9df7-4dc0-4bd7-8fe8-c03e285c819d",
  "objectTable" : "rbac.global",
  "objectIdName" : "global",
  "roleType" : "ADMIN",
  "roleName" : "rbac.global#fdfe9df7-4dc0-4bd7-8fe8-c03e285c819d:ADMIN",
  "roleIdName" : "rbac.global#global:ADMIN"
} ]

Grant the global ADMIN role to the new USER Subject

HTTP POST "/api/rbac/grants" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY" \
  -H 'Hostsharing-Assumed-Roles: rbac.global#global:ADMIN' \
  <<EOF
{
  "assumed" : true,
  "grantedRole.uuid" : "3e03f781-3480-489e-bd5f-85954f8e419f", // globalAdminRoleUuidToGrant
  "granteeSubject.uuid" : "de300000-0000-0000-0000-000000000001"
}
EOF
=> status: 201 CREATED 3e03f781-3480-489e-bd5f-85954f8e419f // globalAdminRoleUuidToGrant

Verify the new global-admin Subject does not have an own Account

HTTP GET "/api/hs/accounts/current" \
  -H "Authorization: Bearer $HSADMINNG_JWT_BEARER" \
  `# {` \
  `#   "sub" : "uuid<hsh-demo_admin>"` \
  `# }`
=> status: 200 OK 
{
  "subject" : {
    "uuid" : "de300000-0000-0000-0000-000000000001",
    "name" : "hsh-demo_admin",
    "organization" : "hsh",
    "type" : "USER"
  },
  "person" : null,
  "globalAdmin" : true
}

UseCase Create Partner => Partner: P-90000 - Tannenhof Bürotechnik eG

Properties

Given

name	value
partnerNumber	P-90000
personType	LEGAL_PERSON
contactCaption	Tannenhof Bürotechnik eG - Hauptkontakt (P-90000)
postalAddress	“street”: “Am Anger 167”, “zipcode”: “86150”, “city”: “Augsburg”, “country”: “Germany”
officePhoneNumber	+49 171 3920080
emailAddress	info@tannenhof-buerotechnik-eg.example.org
tradeName	Tannenhof Bürotechnik eG
registrationOffice	Registergericht Augsburg
registrationNumber	555465

Person: Hostsharing eG

HTTP GET "/api/hs/office/persons?name=Hostsharing+eG" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY"
=> status: 200 OK 
[ {
  "uuid" : "0ef98191-79d8-443e-89c1-1076e8f6df80",
  "personType" : "LEGAL_PERSON",
  "tradeName" : "Hostsharing eG",
  "salutation" : null,
  "title" : null,
  "givenName" : null,
  "familyName" : null
} ]

Even in production data we expect this query to return just a single result.

Person: Tannenhof Bürotechnik eG

HTTP POST "/api/hs/office/persons" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY" \
  <<EOF
{
  "personType" : "LEGAL_PERSON",
  "tradeName" : "Tannenhof Bürotechnik eG"
}
EOF
=> status: 201 CREATED a458fd26-71ff-4145-b649-4e9146d68397

Contact: Tannenhof Bürotechnik eG - Hauptkontakt (P-90000)

HTTP POST "/api/hs/office/contacts" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY" \
  <<EOF
{
  "caption" : "Tannenhof Bürotechnik eG - Hauptkontakt (P-90000)",
  "postalAddress" : {
    "street" : "Am Anger 167",
    "zipcode" : "86150",
    "city" : "Augsburg",
    "country" : "Germany"
  },
  "phoneNumbers" : {
    "office" : "+49 171 3920080"
  },
  "emailAddresses" : {
    "main" : "info@tannenhof-buerotechnik-eg.example.org"
  }
}
EOF
=> status: 201 CREATED 6ed5d747-92ba-44bd-b43f-7c06a4ee82b5

Create Partner: P-90000 - Tannenhof Bürotechnik eG

HTTP POST "/api/hs/office/partners" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY" \
  <<EOF
{
  "partnerNumber" : "P-90000",
  "partnerRel" : {
    "anchor.uuid" : "0ef98191-79d8-443e-89c1-1076e8f6df80", // Person: Hostsharing eG
    "holder.uuid" : "a458fd26-71ff-4145-b649-4e9146d68397", // Person: Tannenhof Bürotechnik eG
    "contact.uuid" : "6ed5d747-92ba-44bd-b43f-7c06a4ee82b5" // Contact: Tannenhof Bürotechnik eG - Hauptkontakt (P-90000)
  },
  "details" : {
    "registrationOffice" : "Registergericht Augsburg",
    "registrationNumber" : "555465"
  }
}
EOF
=> status: 201 CREATED 905afc01-67f8-4179-9163-bc28e2ca925b

Verify the New Partner Relation

HTTP GET "/api/hs/office/relations?relationType=PARTNER&contactData=Tannenhof+B%C3%BCrotechnik+eG+-+Hauptkontakt+%28P-90000%29" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY"
=> status: 200 OK 
[ {
  "uuid" : "c956389b-4633-4988-bd9c-6b481789d174",
  "anchor" : {
    "uuid" : "0ef98191-79d8-443e-89c1-1076e8f6df80", // Person: Hostsharing eG
    "personType" : "LEGAL_PERSON",
    "tradeName" : "Hostsharing eG",
    "salutation" : null,
    "title" : null,
    "givenName" : null,
    "familyName" : null
  },
  "holder" : {
    "uuid" : "a458fd26-71ff-4145-b649-4e9146d68397", // Person: Tannenhof Bürotechnik eG
    "personType" : "LEGAL_PERSON",
    "tradeName" : "Tannenhof Bürotechnik eG",
    "salutation" : null,
    "title" : null,
    "givenName" : null,
    "familyName" : null
  },
  "type" : "PARTNER",
  "mark" : null,
  "contact" : {
    "uuid" : "6ed5d747-92ba-44bd-b43f-7c06a4ee82b5", // Contact: Tannenhof Bürotechnik eG - Hauptkontakt (P-90000)
    "caption" : "Tannenhof Bürotechnik eG - Hauptkontakt (P-90000)",
    "postalAddress" : {
      "zipcode" : "86150",
      "country" : "Germany",
      "city" : "Augsburg",
      "street" : "Am Anger 167"
    },
    "emailAddresses" : {
      "main" : "info@tannenhof-buerotechnik-eg.example.org"
    },
    "phoneNumbers" : {
      "office" : "+49 171 3920080"
    }
  }
} ]

UseCase Add Demo Relation => REPRESENTATIVE: Torsten Schneider - Vertretung (P-90000)

Properties

Given

name	value
partnerPersonName	Tannenhof Bürotechnik eG
relationType	REPRESENTATIVE
holderGivenName	Torsten
holderFamilyName	Schneider
contactCaption	Torsten Schneider - Vertretung (P-90000)
postalAddress	“name”: “Geschäftsführung”, “street”: “Wiesengrund 246”, “zipcode”: “50667”, “city”: “Köln”, “country”: “Germany”
phoneNumber	+49 221 4710870
emailAddress	torsten-schneider@tannenhof-buerotechnik-eg.example.org

Person: Torsten Schneider

HTTP POST "/api/hs/office/persons" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY" \
  <<EOF
{
  "personType" : "NATURAL_PERSON",
  "familyName" : "Schneider",
  "givenName" : "Torsten"
}
EOF
=> status: 201 CREATED a3306341-412d-4466-803b-1ac71ea47bbc

Contact: Torsten Schneider - Vertretung (P-90000)

HTTP POST "/api/hs/office/contacts" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY" \
  <<EOF
{
  "caption" : "Torsten Schneider - Vertretung (P-90000)",
  "postalAddress" : {
    "name" : "Geschäftsführung",
    "street" : "Wiesengrund 246",
    "zipcode" : "50667",
    "city" : "Köln",
    "country" : "Germany"
  },
  "phoneNumbers" : {
    "office" : "+49 221 4710870"
  },
  "emailAddresses" : {
    "main" : "torsten-schneider@tannenhof-buerotechnik-eg.example.org"
  }
}
EOF
=> status: 201 CREATED 1d1df97a-25a2-4be3-9177-083e1a0f40c1

Create REPRESENTATIVE: Torsten Schneider - Vertretung (P-90000)

HTTP POST "/api/hs/office/relations" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY" \
  <<EOF
{
  "type" : "REPRESENTATIVE",
  "anchor.uuid" : "a458fd26-71ff-4145-b649-4e9146d68397", // Person: Tannenhof Bürotechnik eG
  "holder.uuid" : "a3306341-412d-4466-803b-1ac71ea47bbc", // Person: Torsten Schneider
  "contact.uuid" : "1d1df97a-25a2-4be3-9177-083e1a0f40c1" // Contact: Torsten Schneider - Vertretung (P-90000)
}
EOF
=> status: 201 CREATED d07370a6-bc26-491a-b33c-1faeda7422cf

Verify the Relation Got Created

HTTP GET "/api/hs/office/relations/d07370a6-bc26-491a-b33c-1faeda7422cf" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY"
=> status: 200 OK 
{
  "uuid" : "d07370a6-bc26-491a-b33c-1faeda7422cf",
  "anchor" : {
    "uuid" : "a458fd26-71ff-4145-b649-4e9146d68397", // Person: Tannenhof Bürotechnik eG
    "personType" : "LEGAL_PERSON",
    "tradeName" : "Tannenhof Bürotechnik eG",
    "salutation" : null,
    "title" : null,
    "givenName" : null,
    "familyName" : null
  },
  "holder" : {
    "uuid" : "a3306341-412d-4466-803b-1ac71ea47bbc", // Person: Torsten Schneider
    "personType" : "NATURAL_PERSON",
    "tradeName" : null,
    "salutation" : null,
    "title" : null,
    "givenName" : "Torsten",
    "familyName" : "Schneider"
  },
  "type" : "REPRESENTATIVE",
  "mark" : null,
  "contact" : {
    "uuid" : "1d1df97a-25a2-4be3-9177-083e1a0f40c1", // Contact: Torsten Schneider - Vertretung (P-90000)
    "caption" : "Torsten Schneider - Vertretung (P-90000)",
    "postalAddress" : {
      "zipcode" : "50667",
      "country" : "Germany",
      "city" : "Köln",
      "street" : "Wiesengrund 246",
      "name" : "Geschäftsführung"
    },
    "emailAddresses" : {
      "main" : "torsten-schneider@tannenhof-buerotechnik-eg.example.org"
    },
    "phoneNumbers" : {
      "office" : "+49 221 4710870"
    }
  }
}

UseCase Add Demo Relation => REPRESENTATIVE: Susanne Weber - Vertretung (P-90000)

Properties

Given

name	value
partnerPersonName	Tannenhof Bürotechnik eG
relationType	REPRESENTATIVE
holderGivenName	Susanne
holderFamilyName	Weber
contactCaption	Susanne Weber - Vertretung (P-90000)
postalAddress	“street”: “Ulmenstraße 729”, “zipcode”: “44135”, “city”: “Dortmund”, “country”: “Germany”
phoneNumber	+49 171 3920066
emailAddress	susanne-weber@tannenhof-buerotechnik-eg.example.org

Person: Susanne Weber

HTTP POST "/api/hs/office/persons" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY" \
  <<EOF
{
  "personType" : "NATURAL_PERSON",
  "familyName" : "Weber",
  "givenName" : "Susanne"
}
EOF
=> status: 201 CREATED eb16ccfb-73bd-401f-89cd-27a73fd90359

Contact: Susanne Weber - Vertretung (P-90000)

HTTP POST "/api/hs/office/contacts" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY" \
  <<EOF
{
  "caption" : "Susanne Weber - Vertretung (P-90000)",
  "postalAddress" : {
    "street" : "Ulmenstraße 729",
    "zipcode" : "44135",
    "city" : "Dortmund",
    "country" : "Germany"
  },
  "phoneNumbers" : {
    "office" : "+49 171 3920066"
  },
  "emailAddresses" : {
    "main" : "susanne-weber@tannenhof-buerotechnik-eg.example.org"
  }
}
EOF
=> status: 201 CREATED 7cbc602a-9d37-46b9-93e2-96cce4a3bd43

Create REPRESENTATIVE: Susanne Weber - Vertretung (P-90000)

HTTP POST "/api/hs/office/relations" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY" \
  <<EOF
{
  "type" : "REPRESENTATIVE",
  "anchor.uuid" : "a458fd26-71ff-4145-b649-4e9146d68397", // Person: Tannenhof Bürotechnik eG
  "holder.uuid" : "eb16ccfb-73bd-401f-89cd-27a73fd90359", // Person: Susanne Weber
  "contact.uuid" : "7cbc602a-9d37-46b9-93e2-96cce4a3bd43" // Contact: Susanne Weber - Vertretung (P-90000)
}
EOF
=> status: 201 CREATED 1155f0d2-c0e4-4c56-bfee-104b1be732ff

Verify the Relation Got Created

HTTP GET "/api/hs/office/relations/1155f0d2-c0e4-4c56-bfee-104b1be732ff" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY"
=> status: 200 OK 
{
  "uuid" : "1155f0d2-c0e4-4c56-bfee-104b1be732ff",
  "anchor" : {
    "uuid" : "a458fd26-71ff-4145-b649-4e9146d68397", // Person: Tannenhof Bürotechnik eG
    "personType" : "LEGAL_PERSON",
    "tradeName" : "Tannenhof Bürotechnik eG",
    "salutation" : null,
    "title" : null,
    "givenName" : null,
    "familyName" : null
  },
  "holder" : {
    "uuid" : "eb16ccfb-73bd-401f-89cd-27a73fd90359", // Person: Susanne Weber
    "personType" : "NATURAL_PERSON",
    "tradeName" : null,
    "salutation" : null,
    "title" : null,
    "givenName" : "Susanne",
    "familyName" : "Weber"
  },
  "type" : "REPRESENTATIVE",
  "mark" : null,
  "contact" : {
    "uuid" : "7cbc602a-9d37-46b9-93e2-96cce4a3bd43", // Contact: Susanne Weber - Vertretung (P-90000)
    "caption" : "Susanne Weber - Vertretung (P-90000)",
    "postalAddress" : {
      "zipcode" : "44135",
      "country" : "Germany",
      "city" : "Dortmund",
      "street" : "Ulmenstraße 729"
    },
    "emailAddresses" : {
      "main" : "susanne-weber@tannenhof-buerotechnik-eg.example.org"
    },
    "phoneNumbers" : {
      "office" : "+49 171 3920066"
    }
  }
}

UseCase Add Demo Relation => REPRESENTATIVE: Claudia Großbaum - Vertretung (P-90000)

Properties

Given

name	value
partnerPersonName	Tannenhof Bürotechnik eG
relationType	REPRESENTATIVE
holderGivenName	Claudia
holderFamilyName	Großbaum
contactCaption	Claudia Großbaum - Vertretung (P-90000)
postalAddress	“street”: “Am Anger 731”, “zipcode”: “20095”, “city”: “Hamburg”, “country”: “Germany”
phoneNumber	+49 40 66969668
emailAddress	claudia-grossbaum@tannenhof-buerotechnik-eg.example.org

Person: Claudia Großbaum

HTTP POST "/api/hs/office/persons" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY" \
  <<EOF
{
  "personType" : "NATURAL_PERSON",
  "familyName" : "Großbaum",
  "givenName" : "Claudia"
}
EOF
=> status: 201 CREATED e4985dc6-11b8-4198-a72f-3e70338ff290

Contact: Claudia Großbaum - Vertretung (P-90000)

HTTP POST "/api/hs/office/contacts" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY" \
  <<EOF
{
  "caption" : "Claudia Großbaum - Vertretung (P-90000)",
  "postalAddress" : {
    "street" : "Am Anger 731",
    "zipcode" : "20095",
    "city" : "Hamburg",
    "country" : "Germany"
  },
  "phoneNumbers" : {
    "office" : "+49 40 66969668"
  },
  "emailAddresses" : {
    "main" : "claudia-grossbaum@tannenhof-buerotechnik-eg.example.org"
  }
}
EOF
=> status: 201 CREATED 1eb2abb0-4e55-4431-b50f-8ef8443e34b5

Create REPRESENTATIVE: Claudia Großbaum - Vertretung (P-90000)

HTTP POST "/api/hs/office/relations" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY" \
  <<EOF
{
  "type" : "REPRESENTATIVE",
  "anchor.uuid" : "a458fd26-71ff-4145-b649-4e9146d68397", // Person: Tannenhof Bürotechnik eG
  "holder.uuid" : "e4985dc6-11b8-4198-a72f-3e70338ff290", // Person: Claudia Großbaum
  "contact.uuid" : "1eb2abb0-4e55-4431-b50f-8ef8443e34b5" // Contact: Claudia Großbaum - Vertretung (P-90000)
}
EOF
=> status: 201 CREATED 02a0f060-0d82-45ae-96d2-f1ea5a686cfb

Verify the Relation Got Created

HTTP GET "/api/hs/office/relations/02a0f060-0d82-45ae-96d2-f1ea5a686cfb" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY"
=> status: 200 OK 
{
  "uuid" : "02a0f060-0d82-45ae-96d2-f1ea5a686cfb",
  "anchor" : {
    "uuid" : "a458fd26-71ff-4145-b649-4e9146d68397", // Person: Tannenhof Bürotechnik eG
    "personType" : "LEGAL_PERSON",
    "tradeName" : "Tannenhof Bürotechnik eG",
    "salutation" : null,
    "title" : null,
    "givenName" : null,
    "familyName" : null
  },
  "holder" : {
    "uuid" : "e4985dc6-11b8-4198-a72f-3e70338ff290", // Person: Claudia Großbaum
    "personType" : "NATURAL_PERSON",
    "tradeName" : null,
    "salutation" : null,
    "title" : null,
    "givenName" : "Claudia",
    "familyName" : "Großbaum"
  },
  "type" : "REPRESENTATIVE",
  "mark" : null,
  "contact" : {
    "uuid" : "1eb2abb0-4e55-4431-b50f-8ef8443e34b5", // Contact: Claudia Großbaum - Vertretung (P-90000)
    "caption" : "Claudia Großbaum - Vertretung (P-90000)",
    "postalAddress" : {
      "zipcode" : "20095",
      "country" : "Germany",
      "city" : "Hamburg",
      "street" : "Am Anger 731"
    },
    "emailAddresses" : {
      "main" : "claudia-grossbaum@tannenhof-buerotechnik-eg.example.org"
    },
    "phoneNumbers" : {
      "office" : "+49 40 66969668"
    }
  }
}

UseCase Create Demo Debitor => Debitor: Tannenhof Bürotechnik eG - Rechnungsstelle (D-9000000)

Properties

Given

name	value
partnerPersonName	Tannenhof Bürotechnik eG
debitorNumberSuffix	00
billable	true
vatBusiness	true
defaultPrefix	aaa
bankAccountHolder	Tannenhof Bürotechnik eG (P-90000/0)
iban	DE15990200000838881174
bic	DEMVDEH0
billingContactCaption	Tannenhof Bürotechnik eG - Rechnungsstelle (D-9000000)
billingContactEmailAddress	rechnung0@tannenhof-buerotechnik-eg.example.org

BankAccount: Tannenhof Bürotechnik eG (P-90000/0)

HTTP POST "/api/hs/office/bankaccounts" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY" \
  <<EOF
{
  "holder" : "Tannenhof Bürotechnik eG (P-90000/0)",
  "iban" : "DE15990200000838881174",
  "bic" : "DEMVDEH0"
}
EOF
=> status: 201 CREATED f9c62694-d790-4769-ab27-8db38ced3501

Contact: Tannenhof Bürotechnik eG - Rechnungsstelle (D-9000000)

HTTP POST "/api/hs/office/contacts" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY" \
  <<EOF
{
  "caption" : "Tannenhof Bürotechnik eG - Rechnungsstelle (D-9000000)",
  "emailAddresses" : {
    "main" : "rechnung0@tannenhof-buerotechnik-eg.example.org"
  }
}
EOF
=> status: 201 CREATED 9d449762-df68-48bb-8896-d955e1d472f2

Create Debitor: Tannenhof Bürotechnik eG - Rechnungsstelle (D-9000000)

HTTP POST "/api/hs/office/debitors" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY" \
  <<EOF
{
  "debitorRel" : {
    "anchor.uuid" : "a458fd26-71ff-4145-b649-4e9146d68397", // Person: Tannenhof Bürotechnik eG
    "holder.uuid" : "a458fd26-71ff-4145-b649-4e9146d68397", // Person: Tannenhof Bürotechnik eG
    "contact.uuid" : "9d449762-df68-48bb-8896-d955e1d472f2" // Contact: Tannenhof Bürotechnik eG - Rechnungsstelle (D-9000000)
  },
  "debitorNumberSuffix" : "00",
  "billable" : true,
  "vatBusiness" : true,
  "vatReverseCharge" : false,
  "refundBankAccount.uuid" : "f9c62694-d790-4769-ab27-8db38ced3501", // BankAccount: Tannenhof Bürotechnik eG (P-90000/0)
  "defaultPrefix" : "aaa"
}
EOF
=> status: 201 CREATED 04863265-06eb-4738-9237-7d247910c266

Verify the Debitor Got Created

HTTP GET "/api/hs/office/debitors/04863265-06eb-4738-9237-7d247910c266" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY"
=> status: 200 OK 
{
  "uuid" : "04863265-06eb-4738-9237-7d247910c266",
  "debitorRel" : {
    "uuid" : "89295b7a-3ae1-4fb5-bf80-054b833afe7f",
    "anchor" : {
      "uuid" : "a458fd26-71ff-4145-b649-4e9146d68397", // Person: Tannenhof Bürotechnik eG
      "personType" : "LEGAL_PERSON",
      "tradeName" : "Tannenhof Bürotechnik eG",
      "salutation" : null,
      "title" : null,
      "givenName" : null,
      "familyName" : null
    },
    "holder" : {
      "uuid" : "a458fd26-71ff-4145-b649-4e9146d68397", // Person: Tannenhof Bürotechnik eG
      "personType" : "LEGAL_PERSON",
      "tradeName" : "Tannenhof Bürotechnik eG",
      "salutation" : null,
      "title" : null,
      "givenName" : null,
      "familyName" : null
    },
    "type" : "DEBITOR",
    "mark" : null,
    "contact" : {
      "uuid" : "9d449762-df68-48bb-8896-d955e1d472f2", // Contact: Tannenhof Bürotechnik eG - Rechnungsstelle (D-9000000)
      "caption" : "Tannenhof Bürotechnik eG - Rechnungsstelle (D-9000000)",
      "postalAddress" : { },
      "emailAddresses" : {
        "main" : "rechnung0@tannenhof-buerotechnik-eg.example.org"
      },
      "phoneNumbers" : { }
    }
  },
  "debitorNumber" : "D-9000000",
  "debitorNumberSuffix" : "00",
  "partner" : {
    "uuid" : "905afc01-67f8-4179-9163-bc28e2ca925b",
    "partnerNumber" : "P-90000",
    "partnerRel" : {
      "uuid" : "c956389b-4633-4988-bd9c-6b481789d174",
      "anchor" : {
        "uuid" : "0ef98191-79d8-443e-89c1-1076e8f6df80", // Person: Hostsharing eG
        "personType" : "LEGAL_PERSON",
        "tradeName" : "Hostsharing eG",
        "salutation" : null,
        "title" : null,
        "givenName" : null,
        "familyName" : null
      },
      "holder" : {
        "uuid" : "a458fd26-71ff-4145-b649-4e9146d68397", // Person: Tannenhof Bürotechnik eG
        "personType" : "LEGAL_PERSON",
        "tradeName" : "Tannenhof Bürotechnik eG",
        "salutation" : null,
        "title" : null,
        "givenName" : null,
        "familyName" : null
      },
      "type" : "PARTNER",
      "mark" : null,
      "contact" : {
        "uuid" : "6ed5d747-92ba-44bd-b43f-7c06a4ee82b5", // Contact: Tannenhof Bürotechnik eG - Hauptkontakt (P-90000)
        "caption" : "Tannenhof Bürotechnik eG - Hauptkontakt (P-90000)",
        "postalAddress" : {
          "zipcode" : "86150",
          "country" : "Germany",
          "city" : "Augsburg",
          "street" : "Am Anger 167"
        },
        "emailAddresses" : {
          "main" : "info@tannenhof-buerotechnik-eg.example.org"
        },
        "phoneNumbers" : {
          "office" : "+49 171 3920080"
        }
      }
    },
    "details" : {
      "uuid" : "4721594e-995c-4333-98d4-2f5a9bdbc5dd",
      "registrationOffice" : "Registergericht Augsburg",
      "registrationNumber" : "555465",
      "birthName" : null,
      "birthPlace" : null,
      "birthday" : null,
      "dateOfDeath" : null
    }
  },
  "billable" : true,
  "vatId" : null,
  "vatCountryCode" : null,
  "vatBusiness" : true,
  "vatReverseCharge" : false,
  "refundBankAccount" : {
    "uuid" : "f9c62694-d790-4769-ab27-8db38ced3501", // BankAccount: Tannenhof Bürotechnik eG (P-90000/0)
    "holder" : "Tannenhof Bürotechnik eG (P-90000/0)",
    "iban" : "DE15990200000838881174",
    "bic" : "DEMVDEH0"
  },
  "defaultPrefix" : "aaa"
}

UseCase Create Demo Sepa Mandate => SEPA-Mandat: D-9000000-aktuell

Properties

Given

name	value
debitorNumber	D-9000000
mandateReference	D-9000000-aktuell
bankAccountHolder	Tannenhof Bürotechnik eG (P-90000/0/aktuell)
iban	DE86990200000766401011
bic	DEMVDEH0
agreement	2023-03-05
validFrom	2023-03-08

Debitor of D-9000000-aktuell

HTTP GET "/api/hs/office/debitors/D-9000000" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY"
=> status: 200 OK 
{
  "uuid" : "04863265-06eb-4738-9237-7d247910c266",
  "debitorRel" : {
    "uuid" : "89295b7a-3ae1-4fb5-bf80-054b833afe7f",
    "anchor" : {
      "uuid" : "a458fd26-71ff-4145-b649-4e9146d68397", // Person: Tannenhof Bürotechnik eG
      "personType" : "LEGAL_PERSON",
      "tradeName" : "Tannenhof Bürotechnik eG",
      "salutation" : null,
      "title" : null,
      "givenName" : null,
      "familyName" : null
    },
    "holder" : {
      "uuid" : "a458fd26-71ff-4145-b649-4e9146d68397", // Person: Tannenhof Bürotechnik eG
      "personType" : "LEGAL_PERSON",
      "tradeName" : "Tannenhof Bürotechnik eG",
      "salutation" : null,
      "title" : null,
      "givenName" : null,
      "familyName" : null
    },
    "type" : "DEBITOR",
    "mark" : null,
    "contact" : {
      "uuid" : "9d449762-df68-48bb-8896-d955e1d472f2", // Contact: Tannenhof Bürotechnik eG - Rechnungsstelle (D-9000000)
      "caption" : "Tannenhof Bürotechnik eG - Rechnungsstelle (D-9000000)",
      "postalAddress" : { },
      "emailAddresses" : {
        "main" : "rechnung0@tannenhof-buerotechnik-eg.example.org"
      },
      "phoneNumbers" : { }
    }
  },
  "debitorNumber" : "D-9000000",
  "debitorNumberSuffix" : "00",
  "partner" : {
    "uuid" : "905afc01-67f8-4179-9163-bc28e2ca925b",
    "partnerNumber" : "P-90000",
    "partnerRel" : {
      "uuid" : "c956389b-4633-4988-bd9c-6b481789d174",
      "anchor" : {
        "uuid" : "0ef98191-79d8-443e-89c1-1076e8f6df80", // Person: Hostsharing eG
        "personType" : "LEGAL_PERSON",
        "tradeName" : "Hostsharing eG",
        "salutation" : null,
        "title" : null,
        "givenName" : null,
        "familyName" : null
      },
      "holder" : {
        "uuid" : "a458fd26-71ff-4145-b649-4e9146d68397", // Person: Tannenhof Bürotechnik eG
        "personType" : "LEGAL_PERSON",
        "tradeName" : "Tannenhof Bürotechnik eG",
        "salutation" : null,
        "title" : null,
        "givenName" : null,
        "familyName" : null
      },
      "type" : "PARTNER",
      "mark" : null,
      "contact" : {
        "uuid" : "6ed5d747-92ba-44bd-b43f-7c06a4ee82b5", // Contact: Tannenhof Bürotechnik eG - Hauptkontakt (P-90000)
        "caption" : "Tannenhof Bürotechnik eG - Hauptkontakt (P-90000)",
        "postalAddress" : {
          "zipcode" : "86150",
          "country" : "Germany",
          "city" : "Augsburg",
          "street" : "Am Anger 167"
        },
        "emailAddresses" : {
          "main" : "info@tannenhof-buerotechnik-eg.example.org"
        },
        "phoneNumbers" : {
          "office" : "+49 171 3920080"
        }
      }
    },
    "details" : {
      "uuid" : "4721594e-995c-4333-98d4-2f5a9bdbc5dd",
      "registrationOffice" : "Registergericht Augsburg",
      "registrationNumber" : "555465",
      "birthName" : null,
      "birthPlace" : null,
      "birthday" : null,
      "dateOfDeath" : null
    }
  },
  "billable" : true,
  "vatId" : null,
  "vatCountryCode" : null,
  "vatBusiness" : true,
  "vatReverseCharge" : false,
  "refundBankAccount" : {
    "uuid" : "f9c62694-d790-4769-ab27-8db38ced3501", // BankAccount: Tannenhof Bürotechnik eG (P-90000/0)
    "holder" : "Tannenhof Bürotechnik eG (P-90000/0)",
    "iban" : "DE15990200000838881174",
    "bic" : "DEMVDEH0"
  },
  "defaultPrefix" : "aaa"
}

BankAccount: Tannenhof Bürotechnik eG (P-90000/0/aktuell)

HTTP POST "/api/hs/office/bankaccounts" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY" \
  <<EOF
{
  "holder" : "Tannenhof Bürotechnik eG (P-90000/0/aktuell)",
  "iban" : "DE86990200000766401011",
  "bic" : "DEMVDEH0"
}
EOF
=> status: 201 CREATED aade0a08-32ef-437f-aaae-903537bba496

Create SEPA-Mandat: D-9000000-aktuell

HTTP POST "/api/hs/office/sepamandates" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY" \
  <<EOF
{
  "debitor.uuid" : "04863265-06eb-4738-9237-7d247910c266", // Debitor of D-9000000-aktuell
  "bankAccount.uuid" : "aade0a08-32ef-437f-aaae-903537bba496", // BankAccount: Tannenhof Bürotechnik eG (P-90000/0/aktuell)
  "reference" : "D-9000000-aktuell",
  "agreement" : "2023-03-05",
  "validFrom" : "2023-03-08"
}
EOF
=> status: 201 CREATED 2a835a31-e6c6-464d-91d4-1780041d933c

Verify the SEPA-Mandate Got Created

HTTP GET "/api/hs/office/sepamandates/2a835a31-e6c6-464d-91d4-1780041d933c" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY"
=> status: 200 OK 
{
  "uuid" : "2a835a31-e6c6-464d-91d4-1780041d933c",
  "debitor" : {
    "uuid" : "04863265-06eb-4738-9237-7d247910c266", // Debitor of D-9000000-aktuell
    "debitorRel" : {
      "uuid" : "89295b7a-3ae1-4fb5-bf80-054b833afe7f",
      "anchor" : {
        "uuid" : "a458fd26-71ff-4145-b649-4e9146d68397", // Person: Tannenhof Bürotechnik eG
        "personType" : "LEGAL_PERSON",
        "tradeName" : "Tannenhof Bürotechnik eG",
        "salutation" : null,
        "title" : null,
        "givenName" : null,
        "familyName" : null
      },
      "holder" : {
        "uuid" : "a458fd26-71ff-4145-b649-4e9146d68397", // Person: Tannenhof Bürotechnik eG
        "personType" : "LEGAL_PERSON",
        "tradeName" : "Tannenhof Bürotechnik eG",
        "salutation" : null,
        "title" : null,
        "givenName" : null,
        "familyName" : null
      },
      "type" : "DEBITOR",
      "mark" : null,
      "contact" : {
        "uuid" : "9d449762-df68-48bb-8896-d955e1d472f2", // Contact: Tannenhof Bürotechnik eG - Rechnungsstelle (D-9000000)
        "caption" : "Tannenhof Bürotechnik eG - Rechnungsstelle (D-9000000)",
        "postalAddress" : { },
        "emailAddresses" : {
          "main" : "rechnung0@tannenhof-buerotechnik-eg.example.org"
        },
        "phoneNumbers" : { }
      }
    },
    "debitorNumber" : "D-9000000",
    "debitorNumberSuffix" : "00",
    "partner" : {
      "uuid" : "905afc01-67f8-4179-9163-bc28e2ca925b",
      "partnerNumber" : "P-90000",
      "partnerRel" : {
        "uuid" : "c956389b-4633-4988-bd9c-6b481789d174",
        "anchor" : {
          "uuid" : "0ef98191-79d8-443e-89c1-1076e8f6df80", // Person: Hostsharing eG
          "personType" : "LEGAL_PERSON",
          "tradeName" : "Hostsharing eG",
          "salutation" : null,
          "title" : null,
          "givenName" : null,
          "familyName" : null
        },
        "holder" : {
          "uuid" : "a458fd26-71ff-4145-b649-4e9146d68397", // Person: Tannenhof Bürotechnik eG
          "personType" : "LEGAL_PERSON",
          "tradeName" : "Tannenhof Bürotechnik eG",
          "salutation" : null,
          "title" : null,
          "givenName" : null,
          "familyName" : null
        },
        "type" : "PARTNER",
        "mark" : null,
        "contact" : {
          "uuid" : "6ed5d747-92ba-44bd-b43f-7c06a4ee82b5", // Contact: Tannenhof Bürotechnik eG - Hauptkontakt (P-90000)
          "caption" : "Tannenhof Bürotechnik eG - Hauptkontakt (P-90000)",
          "postalAddress" : {
            "zipcode" : "86150",
            "country" : "Germany",
            "city" : "Augsburg",
            "street" : "Am Anger 167"
          },
          "emailAddresses" : {
            "main" : "info@tannenhof-buerotechnik-eg.example.org"
          },
          "phoneNumbers" : {
            "office" : "+49 171 3920080"
          }
        }
      },
      "details" : {
        "uuid" : "4721594e-995c-4333-98d4-2f5a9bdbc5dd",
        "registrationOffice" : "Registergericht Augsburg",
        "registrationNumber" : "555465",
        "birthName" : null,
        "birthPlace" : null,
        "birthday" : null,
        "dateOfDeath" : null
      }
    },
    "billable" : true,
    "vatId" : null,
    "vatCountryCode" : null,
    "vatBusiness" : true,
    "vatReverseCharge" : false,
    "refundBankAccount" : {
      "uuid" : "f9c62694-d790-4769-ab27-8db38ced3501", // BankAccount: Tannenhof Bürotechnik eG (P-90000/0)
      "holder" : "Tannenhof Bürotechnik eG (P-90000/0)",
      "iban" : "DE15990200000838881174",
      "bic" : "DEMVDEH0"
    },
    "defaultPrefix" : "aaa"
  },
  "bankAccount" : {
    "uuid" : "aade0a08-32ef-437f-aaae-903537bba496", // BankAccount: Tannenhof Bürotechnik eG (P-90000/0/aktuell)
    "holder" : "Tannenhof Bürotechnik eG (P-90000/0/aktuell)",
    "iban" : "DE86990200000766401011",
    "bic" : "DEMVDEH0"
  },
  "reference" : "D-9000000-aktuell",
  "agreement" : "2023-03-05",
  "validFrom" : "2023-03-08",
  "validTo" : null
}

UseCase Create Membership => Membership: Tannenhof Bürotechnik eG

Properties

Given

name	value
partnerNumber	P-90000
validFrom	2011-05-13
membershipFeeBillable	true

Partner: P-90000

HTTP GET "/api/hs/office/partners/P-90000" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY"
=> status: 200 OK 
{
  "uuid" : "905afc01-67f8-4179-9163-bc28e2ca925b",
  "partnerNumber" : "P-90000",
  "partnerRel" : {
    "uuid" : "c956389b-4633-4988-bd9c-6b481789d174",
    "anchor" : {
      "uuid" : "0ef98191-79d8-443e-89c1-1076e8f6df80", // Person: Hostsharing eG
      "personType" : "LEGAL_PERSON",
      "tradeName" : "Hostsharing eG",
      "salutation" : null,
      "title" : null,
      "givenName" : null,
      "familyName" : null
    },
    "holder" : {
      "uuid" : "a458fd26-71ff-4145-b649-4e9146d68397", // Person: Tannenhof Bürotechnik eG
      "personType" : "LEGAL_PERSON",
      "tradeName" : "Tannenhof Bürotechnik eG",
      "salutation" : null,
      "title" : null,
      "givenName" : null,
      "familyName" : null
    },
    "type" : "PARTNER",
    "mark" : null,
    "contact" : {
      "uuid" : "6ed5d747-92ba-44bd-b43f-7c06a4ee82b5", // Contact: Tannenhof Bürotechnik eG - Hauptkontakt (P-90000)
      "caption" : "Tannenhof Bürotechnik eG - Hauptkontakt (P-90000)",
      "postalAddress" : {
        "zipcode" : "86150",
        "country" : "Germany",
        "city" : "Augsburg",
        "street" : "Am Anger 167"
      },
      "emailAddresses" : {
        "main" : "info@tannenhof-buerotechnik-eg.example.org"
      },
      "phoneNumbers" : {
        "office" : "+49 171 3920080"
      }
    }
  },
  "details" : {
    "uuid" : "4721594e-995c-4333-98d4-2f5a9bdbc5dd",
    "registrationOffice" : "Registergericht Augsburg",
    "registrationNumber" : "555465",
    "birthName" : null,
    "birthPlace" : null,
    "birthday" : null,
    "dateOfDeath" : null
  }
}

The partner-number identifies the partner; a lookup by name could not, because a natural person carries its name in two columns and any name can be the prefix of a longer one.

Create Membership: Tannenhof Bürotechnik eG

HTTP POST "/api/hs/office/memberships" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY" \
  <<EOF
{
  "partner.uuid" : "905afc01-67f8-4179-9163-bc28e2ca925b", // Partner: P-90000
  "memberNumberSuffix" : "00",
  "status" : "ACTIVE",
  "validFrom" : "2011-05-13",
  "membershipFeeBillable" : true
}
EOF
=> status: 201 CREATED b9e8b323-4fad-42fe-b3fa-37b514bb2bf2

Verify That the Membership Got Created

HTTP GET "/api/hs/office/memberships/b9e8b323-4fad-42fe-b3fa-37b514bb2bf2" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY"
=> status: 200 OK 
{
  "uuid" : "b9e8b323-4fad-42fe-b3fa-37b514bb2bf2",
  "partner" : {
    "uuid" : "905afc01-67f8-4179-9163-bc28e2ca925b", // Partner: P-90000
    "partnerNumber" : "P-90000",
    "partnerRel" : {
      "uuid" : "c956389b-4633-4988-bd9c-6b481789d174",
      "anchor" : {
        "uuid" : "0ef98191-79d8-443e-89c1-1076e8f6df80", // Person: Hostsharing eG
        "personType" : "LEGAL_PERSON",
        "tradeName" : "Hostsharing eG",
        "salutation" : null,
        "title" : null,
        "givenName" : null,
        "familyName" : null
      },
      "holder" : {
        "uuid" : "a458fd26-71ff-4145-b649-4e9146d68397", // Person: Tannenhof Bürotechnik eG
        "personType" : "LEGAL_PERSON",
        "tradeName" : "Tannenhof Bürotechnik eG",
        "salutation" : null,
        "title" : null,
        "givenName" : null,
        "familyName" : null
      },
      "type" : "PARTNER",
      "mark" : null,
      "contact" : {
        "uuid" : "6ed5d747-92ba-44bd-b43f-7c06a4ee82b5", // Contact: Tannenhof Bürotechnik eG - Hauptkontakt (P-90000)
        "caption" : "Tannenhof Bürotechnik eG - Hauptkontakt (P-90000)",
        "postalAddress" : {
          "zipcode" : "86150",
          "country" : "Germany",
          "city" : "Augsburg",
          "street" : "Am Anger 167"
        },
        "emailAddresses" : {
          "main" : "info@tannenhof-buerotechnik-eg.example.org"
        },
        "phoneNumbers" : {
          "office" : "+49 171 3920080"
        }
      }
    },
    "details" : {
      "uuid" : "4721594e-995c-4333-98d4-2f5a9bdbc5dd",
      "registrationOffice" : "Registergericht Augsburg",
      "registrationNumber" : "555465",
      "birthName" : null,
      "birthPlace" : null,
      "birthday" : null,
      "dateOfDeath" : null
    }
  },
  "mainDebitor" : null,
  "memberNumber" : "M-9000000",
  "memberNumberSuffix" : "00",
  "validFrom" : "2011-05-13",
  "validTo" : null,
  "status" : "ACTIVE",
  "membershipFeeBillable" : true
}

Properties

Given

name	value
transactionType	SUBSCRIPTION
memberNumber	M-9000000
reference	sign 2011-05-13
shareCount	37
comment	initial shares on joining
transactionDate	2011-05-13

Find membershipUuid

HTTP GET "/api/hs/office/memberships/M-9000000" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY"
=> status: 200 OK 
{
  "uuid" : "b9e8b323-4fad-42fe-b3fa-37b514bb2bf2",
  "partner" : {
    "uuid" : "905afc01-67f8-4179-9163-bc28e2ca925b", // Partner: P-90000
    "partnerNumber" : "P-90000",
    "partnerRel" : {
      "uuid" : "c956389b-4633-4988-bd9c-6b481789d174",
      "anchor" : {
        "uuid" : "0ef98191-79d8-443e-89c1-1076e8f6df80", // Person: Hostsharing eG
        "personType" : "LEGAL_PERSON",
        "tradeName" : "Hostsharing eG",
        "salutation" : null,
        "title" : null,
        "givenName" : null,
        "familyName" : null
      },
      "holder" : {
        "uuid" : "a458fd26-71ff-4145-b649-4e9146d68397", // Person: Tannenhof Bürotechnik eG
        "personType" : "LEGAL_PERSON",
        "tradeName" : "Tannenhof Bürotechnik eG",
        "salutation" : null,
        "title" : null,
        "givenName" : null,
        "familyName" : null
      },
      "type" : "PARTNER",
      "mark" : null,
      "contact" : {
        "uuid" : "6ed5d747-92ba-44bd-b43f-7c06a4ee82b5", // Contact: Tannenhof Bürotechnik eG - Hauptkontakt (P-90000)
        "caption" : "Tannenhof Bürotechnik eG - Hauptkontakt (P-90000)",
        "postalAddress" : {
          "zipcode" : "86150",
          "country" : "Germany",
          "city" : "Augsburg",
          "street" : "Am Anger 167"
        },
        "emailAddresses" : {
          "main" : "info@tannenhof-buerotechnik-eg.example.org"
        },
        "phoneNumbers" : {
          "office" : "+49 171 3920080"
        }
      }
    },
    "details" : {
      "uuid" : "4721594e-995c-4333-98d4-2f5a9bdbc5dd",
      "registrationOffice" : "Registergericht Augsburg",
      "registrationNumber" : "555465",
      "birthName" : null,
      "birthPlace" : null,
      "birthday" : null,
      "dateOfDeath" : null
    }
  },
  "mainDebitor" : null,
  "memberNumber" : "M-9000000",
  "memberNumberSuffix" : "00",
  "validFrom" : "2011-05-13",
  "validTo" : null,
  "status" : "ACTIVE",
  "membershipFeeBillable" : true
}

Create the Coop-Shares-SUBSCRIPTION Transaction

HTTP POST "/api/hs/office/coopsharestransactions" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY" \
  <<EOF
{
  "membership.uuid" : "b9e8b323-4fad-42fe-b3fa-37b514bb2bf2", // membershipUuid
  "transactionType" : "SUBSCRIPTION",
  "reference" : "sign 2011-05-13",
  "shareCount" : 37,
  "comment" : "initial shares on joining",
  "valueDate" : "2011-05-13"
}
EOF
=> status: 201 CREATED 98a0bd44-01c0-414b-b6e2-9a1c644ca3d5

Verify Coop-Shares SUBSCRIPTION-Transaction

HTTP GET "/api/hs/office/coopsharestransactions/98a0bd44-01c0-414b-b6e2-9a1c644ca3d5" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY"
=> status: 200 OK 
{
  "uuid" : "98a0bd44-01c0-414b-b6e2-9a1c644ca3d5",
  "membership.uuid" : "b9e8b323-4fad-42fe-b3fa-37b514bb2bf2", // membershipUuid
  "transactionType" : "SUBSCRIPTION",
  "shareCount" : 37,
  "valueDate" : "2011-05-13",
  "reference" : "sign 2011-05-13",
  "comment" : "initial shares on joining",
  "revertedShareTx" : null,
  "reversalShareTx" : null
}

Properties

Given

name	value
transactionType	DEPOSIT
memberNumber	M-9000000
reference	sign 2011-05-13
assetValue	2368
comment	deposit for initial shares
transactionDate	2011-06-01

Find membershipUuid

HTTP GET "/api/hs/office/memberships/M-9000000" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY"
=> status: 200 OK 
{
  "uuid" : "b9e8b323-4fad-42fe-b3fa-37b514bb2bf2", // membershipUuid
  "partner" : {
    "uuid" : "905afc01-67f8-4179-9163-bc28e2ca925b", // Partner: P-90000
    "partnerNumber" : "P-90000",
    "partnerRel" : {
      "uuid" : "c956389b-4633-4988-bd9c-6b481789d174",
      "anchor" : {
        "uuid" : "0ef98191-79d8-443e-89c1-1076e8f6df80", // Person: Hostsharing eG
        "personType" : "LEGAL_PERSON",
        "tradeName" : "Hostsharing eG",
        "salutation" : null,
        "title" : null,
        "givenName" : null,
        "familyName" : null
      },
      "holder" : {
        "uuid" : "a458fd26-71ff-4145-b649-4e9146d68397", // Person: Tannenhof Bürotechnik eG
        "personType" : "LEGAL_PERSON",
        "tradeName" : "Tannenhof Bürotechnik eG",
        "salutation" : null,
        "title" : null,
        "givenName" : null,
        "familyName" : null
      },
      "type" : "PARTNER",
      "mark" : null,
      "contact" : {
        "uuid" : "6ed5d747-92ba-44bd-b43f-7c06a4ee82b5", // Contact: Tannenhof Bürotechnik eG - Hauptkontakt (P-90000)
        "caption" : "Tannenhof Bürotechnik eG - Hauptkontakt (P-90000)",
        "postalAddress" : {
          "zipcode" : "86150",
          "country" : "Germany",
          "city" : "Augsburg",
          "street" : "Am Anger 167"
        },
        "emailAddresses" : {
          "main" : "info@tannenhof-buerotechnik-eg.example.org"
        },
        "phoneNumbers" : {
          "office" : "+49 171 3920080"
        }
      }
    },
    "details" : {
      "uuid" : "4721594e-995c-4333-98d4-2f5a9bdbc5dd",
      "registrationOffice" : "Registergericht Augsburg",
      "registrationNumber" : "555465",
      "birthName" : null,
      "birthPlace" : null,
      "birthday" : null,
      "dateOfDeath" : null
    }
  },
  "mainDebitor" : null,
  "memberNumber" : "M-9000000",
  "memberNumberSuffix" : "00",
  "validFrom" : "2011-05-13",
  "validTo" : null,
  "status" : "ACTIVE",
  "membershipFeeBillable" : true
}

Create the Coop-Assets-DEPOSIT Transaction

HTTP POST "/api/hs/office/coopassetstransactions" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY" \
  <<EOF
{
  "membership.uuid" : "b9e8b323-4fad-42fe-b3fa-37b514bb2bf2", // membershipUuid
  "transactionType" : "DEPOSIT",
  "reference" : "sign 2011-05-13",
  "assetValue" : 2368,
  "comment" : "deposit for initial shares",
  "valueDate" : "2011-06-01"
}
EOF
=> status: 201 CREATED cfc482f4-f5e1-4743-af4b-5c70cd4f155b

Verify Coop-Assets DEPOSIT-Transaction

HTTP GET "/api/hs/office/coopassetstransactions/cfc482f4-f5e1-4743-af4b-5c70cd4f155b" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY"
=> status: 200 OK 
{
  "uuid" : "cfc482f4-f5e1-4743-af4b-5c70cd4f155b",
  "membership.uuid" : "b9e8b323-4fad-42fe-b3fa-37b514bb2bf2", // membershipUuid
  "membership.memberNumber" : "M-9000000",
  "transactionType" : "DEPOSIT",
  "assetValue" : 2368,
  "valueDate" : "2011-06-01",
  "reference" : "sign 2011-05-13",
  "comment" : "deposit for initial shares",
  "adoptionAssetTx" : null,
  "transferAssetTx" : null,
  "revertedAssetTx" : null,
  "reversalAssetTx" : null
}

UseCase Add Demo Subscription => SUBSCRIBER generalversammlung: Susanne Weber (P-90000)

Properties

Given

name	value
partnerPersonName	Tannenhof Bürotechnik eG
mailingList	generalversammlung
holderGivenName	Susanne
holderFamilyName	Weber
contactCaption	Susanne Weber - Vertretung (P-90000)

Create SUBSCRIBER generalversammlung: Susanne Weber (P-90000)

HTTP POST "/api/hs/office/relations" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY" \
  <<EOF
{
  "type" : "SUBSCRIBER",
  "mark" : "generalversammlung",
  "anchor.uuid" : "a458fd26-71ff-4145-b649-4e9146d68397", // Person: Tannenhof Bürotechnik eG
  "holder.uuid" : "eb16ccfb-73bd-401f-89cd-27a73fd90359", // Person: Susanne Weber
  "contact.uuid" : "7cbc602a-9d37-46b9-93e2-96cce4a3bd43" // Contact: Susanne Weber - Vertretung (P-90000)
}
EOF
=> status: 201 CREATED 9dff3cf6-5f5b-44ef-8a85-df84088264ef

Verify the Subscription Got Created

HTTP GET "/api/hs/office/relations/9dff3cf6-5f5b-44ef-8a85-df84088264ef" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY"
=> status: 200 OK 
{
  "uuid" : "9dff3cf6-5f5b-44ef-8a85-df84088264ef",
  "anchor" : {
    "uuid" : "a458fd26-71ff-4145-b649-4e9146d68397", // Person: Tannenhof Bürotechnik eG
    "personType" : "LEGAL_PERSON",
    "tradeName" : "Tannenhof Bürotechnik eG",
    "salutation" : null,
    "title" : null,
    "givenName" : null,
    "familyName" : null
  },
  "holder" : {
    "uuid" : "eb16ccfb-73bd-401f-89cd-27a73fd90359", // Person: Susanne Weber
    "personType" : "NATURAL_PERSON",
    "tradeName" : null,
    "salutation" : null,
    "title" : null,
    "givenName" : "Susanne",
    "familyName" : "Weber"
  },
  "type" : "SUBSCRIBER",
  "mark" : "generalversammlung",
  "contact" : {
    "uuid" : "7cbc602a-9d37-46b9-93e2-96cce4a3bd43", // Contact: Susanne Weber - Vertretung (P-90000)
    "caption" : "Susanne Weber - Vertretung (P-90000)",
    "postalAddress" : {
      "zipcode" : "44135",
      "country" : "Germany",
      "city" : "Dortmund",
      "street" : "Ulmenstraße 729"
    },
    "emailAddresses" : {
      "main" : "susanne-weber@tannenhof-buerotechnik-eg.example.org"
    },
    "phoneNumbers" : {
      "office" : "+49 171 3920066"
    }
  }
}

Contact: Torsten Schneider - private Mailinglisten-Adresse

HTTP POST "/api/hs/office/contacts" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY" \
  <<EOF
{
  "caption" : "Torsten Schneider - private Mailinglisten-Adresse",
  "postalAddress" : {
    "street" : "Birkenallee 253",
    "zipcode" : "80331",
    "city" : "München",
    "country" : "Germany"
  },
  "phoneNumbers" : {
    "main" : "+49 89 99998954"
  },
  "emailAddresses" : {
    "main" : "torsten-schneider@example.net"
  }
}
EOF
=> status: 201 CREATED f0686833-803a-46a5-9395-f7d5edd00198

UseCase Add Demo Subscription => SUBSCRIBER members-announce: Torsten Schneider (P-90000)

Properties

Given

name	value
partnerPersonName	Tannenhof Bürotechnik eG
mailingList	members-announce
holderGivenName	Torsten
holderFamilyName	Schneider
contactCaption	Torsten Schneider - private Mailinglisten-Adresse

Create SUBSCRIBER members-announce: Torsten Schneider (P-90000)

HTTP POST "/api/hs/office/relations" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY" \
  <<EOF
{
  "type" : "SUBSCRIBER",
  "mark" : "members-announce",
  "anchor.uuid" : "a458fd26-71ff-4145-b649-4e9146d68397", // Person: Tannenhof Bürotechnik eG
  "holder.uuid" : "a3306341-412d-4466-803b-1ac71ea47bbc", // Person: Torsten Schneider
  "contact.uuid" : "f0686833-803a-46a5-9395-f7d5edd00198" // Contact: Torsten Schneider - private Mailinglisten-Adresse
}
EOF
=> status: 201 CREATED ca9d464e-0fde-47b1-a24a-35cf7e412b03

Verify the Subscription Got Created

HTTP GET "/api/hs/office/relations/ca9d464e-0fde-47b1-a24a-35cf7e412b03" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY"
=> status: 200 OK 
{
  "uuid" : "ca9d464e-0fde-47b1-a24a-35cf7e412b03",
  "anchor" : {
    "uuid" : "a458fd26-71ff-4145-b649-4e9146d68397", // Person: Tannenhof Bürotechnik eG
    "personType" : "LEGAL_PERSON",
    "tradeName" : "Tannenhof Bürotechnik eG",
    "salutation" : null,
    "title" : null,
    "givenName" : null,
    "familyName" : null
  },
  "holder" : {
    "uuid" : "a3306341-412d-4466-803b-1ac71ea47bbc", // Person: Torsten Schneider
    "personType" : "NATURAL_PERSON",
    "tradeName" : null,
    "salutation" : null,
    "title" : null,
    "givenName" : "Torsten",
    "familyName" : "Schneider"
  },
  "type" : "SUBSCRIBER",
  "mark" : "members-announce",
  "contact" : {
    "uuid" : "f0686833-803a-46a5-9395-f7d5edd00198", // Contact: Torsten Schneider - private Mailinglisten-Adresse
    "caption" : "Torsten Schneider - private Mailinglisten-Adresse",
    "postalAddress" : {
      "zipcode" : "80331",
      "country" : "Germany",
      "city" : "München",
      "street" : "Birkenallee 253"
    },
    "emailAddresses" : {
      "main" : "torsten-schneider@example.net"
    },
    "phoneNumbers" : {
      "main" : "+49 89 99998954"
    }
  }
}

UseCase Add Demo Subscription => SUBSCRIBER customers-announce: Torsten Schneider (P-90000)

Properties

Given

name	value
partnerPersonName	Tannenhof Bürotechnik eG
mailingList	customers-announce
holderGivenName	Torsten
holderFamilyName	Schneider
contactCaption	Torsten Schneider - private Mailinglisten-Adresse

Create SUBSCRIBER customers-announce: Torsten Schneider (P-90000)

HTTP POST "/api/hs/office/relations" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY" \
  <<EOF
{
  "type" : "SUBSCRIBER",
  "mark" : "customers-announce",
  "anchor.uuid" : "a458fd26-71ff-4145-b649-4e9146d68397", // Person: Tannenhof Bürotechnik eG
  "holder.uuid" : "a3306341-412d-4466-803b-1ac71ea47bbc", // Person: Torsten Schneider
  "contact.uuid" : "f0686833-803a-46a5-9395-f7d5edd00198" // Contact: Torsten Schneider - private Mailinglisten-Adresse
}
EOF
=> status: 201 CREATED 45e2a327-ba0b-4299-b805-609cf415519c

Verify the Subscription Got Created

HTTP GET "/api/hs/office/relations/45e2a327-ba0b-4299-b805-609cf415519c" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY"
=> status: 200 OK 
{
  "uuid" : "45e2a327-ba0b-4299-b805-609cf415519c",
  "anchor" : {
    "uuid" : "a458fd26-71ff-4145-b649-4e9146d68397", // Person: Tannenhof Bürotechnik eG
    "personType" : "LEGAL_PERSON",
    "tradeName" : "Tannenhof Bürotechnik eG",
    "salutation" : null,
    "title" : null,
    "givenName" : null,
    "familyName" : null
  },
  "holder" : {
    "uuid" : "a3306341-412d-4466-803b-1ac71ea47bbc", // Person: Torsten Schneider
    "personType" : "NATURAL_PERSON",
    "tradeName" : null,
    "salutation" : null,
    "title" : null,
    "givenName" : "Torsten",
    "familyName" : "Schneider"
  },
  "type" : "SUBSCRIBER",
  "mark" : "customers-announce",
  "contact" : {
    "uuid" : "f0686833-803a-46a5-9395-f7d5edd00198", // Contact: Torsten Schneider - private Mailinglisten-Adresse
    "caption" : "Torsten Schneider - private Mailinglisten-Adresse",
    "postalAddress" : {
      "zipcode" : "80331",
      "country" : "Germany",
      "city" : "München",
      "street" : "Birkenallee 253"
    },
    "emailAddresses" : {
      "main" : "torsten-schneider@example.net"
    },
    "phoneNumbers" : {
      "main" : "+49 89 99998954"
    }
  }
}

Contact: Susanne Weber - private Mailinglisten-Adresse

HTTP POST "/api/hs/office/contacts" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY" \
  <<EOF
{
  "caption" : "Susanne Weber - private Mailinglisten-Adresse",
  "postalAddress" : {
    "name" : "Geschäftsführung",
    "street" : "Schlehenweg 260",
    "zipcode" : "80331",
    "city" : "München",
    "country" : "Germany"
  },
  "phoneNumbers" : {
    "main" : "+49 89 99998045"
  },
  "emailAddresses" : {
    "main" : "susanne-weber@example.net"
  }
}
EOF
=> status: 201 CREATED 5582994d-10c1-4398-8fac-15f99236fdf5

UseCase Add Demo Subscription => SUBSCRIBER customers-discuss: Susanne Weber (P-90000)

Properties

Given

name	value
partnerPersonName	Tannenhof Bürotechnik eG
mailingList	customers-discuss
holderGivenName	Susanne
holderFamilyName	Weber
contactCaption	Susanne Weber - private Mailinglisten-Adresse

Create SUBSCRIBER customers-discuss: Susanne Weber (P-90000)

HTTP POST "/api/hs/office/relations" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY" \
  <<EOF
{
  "type" : "SUBSCRIBER",
  "mark" : "customers-discuss",
  "anchor.uuid" : "a458fd26-71ff-4145-b649-4e9146d68397", // Person: Tannenhof Bürotechnik eG
  "holder.uuid" : "eb16ccfb-73bd-401f-89cd-27a73fd90359", // Person: Susanne Weber
  "contact.uuid" : "5582994d-10c1-4398-8fac-15f99236fdf5" // Contact: Susanne Weber - private Mailinglisten-Adresse
}
EOF
=> status: 201 CREATED 9cc66180-cb69-4f6a-9401-11de3e6ac12c

Verify the Subscription Got Created

HTTP GET "/api/hs/office/relations/9cc66180-cb69-4f6a-9401-11de3e6ac12c" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY"
=> status: 200 OK 
{
  "uuid" : "9cc66180-cb69-4f6a-9401-11de3e6ac12c",
  "anchor" : {
    "uuid" : "a458fd26-71ff-4145-b649-4e9146d68397", // Person: Tannenhof Bürotechnik eG
    "personType" : "LEGAL_PERSON",
    "tradeName" : "Tannenhof Bürotechnik eG",
    "salutation" : null,
    "title" : null,
    "givenName" : null,
    "familyName" : null
  },
  "holder" : {
    "uuid" : "eb16ccfb-73bd-401f-89cd-27a73fd90359", // Person: Susanne Weber
    "personType" : "NATURAL_PERSON",
    "tradeName" : null,
    "salutation" : null,
    "title" : null,
    "givenName" : "Susanne",
    "familyName" : "Weber"
  },
  "type" : "SUBSCRIBER",
  "mark" : "customers-discuss",
  "contact" : {
    "uuid" : "5582994d-10c1-4398-8fac-15f99236fdf5", // Contact: Susanne Weber - private Mailinglisten-Adresse
    "caption" : "Susanne Weber - private Mailinglisten-Adresse",
    "postalAddress" : {
      "zipcode" : "80331",
      "country" : "Germany",
      "city" : "München",
      "street" : "Schlehenweg 260",
      "name" : "Geschäftsführung"
    },
    "emailAddresses" : {
      "main" : "susanne-weber@example.net"
    },
    "phoneNumbers" : {
      "main" : "+49 89 99998045"
    }
  }
}

UseCase Add Demo Subscription => SUBSCRIBER operations-announce: Torsten Schneider (P-90000)

Properties

Given

name	value
partnerPersonName	Tannenhof Bürotechnik eG
mailingList	operations-announce
holderGivenName	Torsten
holderFamilyName	Schneider
contactCaption	Torsten Schneider - Vertretung (P-90000)

Create SUBSCRIBER operations-announce: Torsten Schneider (P-90000)

HTTP POST "/api/hs/office/relations" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY" \
  <<EOF
{
  "type" : "SUBSCRIBER",
  "mark" : "operations-announce",
  "anchor.uuid" : "a458fd26-71ff-4145-b649-4e9146d68397", // Person: Tannenhof Bürotechnik eG
  "holder.uuid" : "a3306341-412d-4466-803b-1ac71ea47bbc", // Person: Torsten Schneider
  "contact.uuid" : "1d1df97a-25a2-4be3-9177-083e1a0f40c1" // Contact: Torsten Schneider - Vertretung (P-90000)
}
EOF
=> status: 201 CREATED 2a45cd38-0edb-4d75-8eb1-e53a947d6bc2

Verify the Subscription Got Created

HTTP GET "/api/hs/office/relations/2a45cd38-0edb-4d75-8eb1-e53a947d6bc2" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY"
=> status: 200 OK 
{
  "uuid" : "2a45cd38-0edb-4d75-8eb1-e53a947d6bc2",
  "anchor" : {
    "uuid" : "a458fd26-71ff-4145-b649-4e9146d68397", // Person: Tannenhof Bürotechnik eG
    "personType" : "LEGAL_PERSON",
    "tradeName" : "Tannenhof Bürotechnik eG",
    "salutation" : null,
    "title" : null,
    "givenName" : null,
    "familyName" : null
  },
  "holder" : {
    "uuid" : "a3306341-412d-4466-803b-1ac71ea47bbc", // Person: Torsten Schneider
    "personType" : "NATURAL_PERSON",
    "tradeName" : null,
    "salutation" : null,
    "title" : null,
    "givenName" : "Torsten",
    "familyName" : "Schneider"
  },
  "type" : "SUBSCRIBER",
  "mark" : "operations-announce",
  "contact" : {
    "uuid" : "1d1df97a-25a2-4be3-9177-083e1a0f40c1", // Contact: Torsten Schneider - Vertretung (P-90000)
    "caption" : "Torsten Schneider - Vertretung (P-90000)",
    "postalAddress" : {
      "zipcode" : "50667",
      "country" : "Germany",
      "city" : "Köln",
      "street" : "Wiesengrund 246",
      "name" : "Geschäftsführung"
    },
    "emailAddresses" : {
      "main" : "torsten-schneider@tannenhof-buerotechnik-eg.example.org"
    },
    "phoneNumbers" : {
      "office" : "+49 221 4710870"
    }
  }
}

UseCase Create Partner => Partner: P-90001 - Christian Krause

Properties

Given

name	value
partnerNumber	P-90001
personType	NATURAL_PERSON
contactCaption	Christian Krause - Hauptkontakt (P-90001)
postalAddress	“name”: “Buchhaltung”, “street”: “Kirschblütenweg 603”, “zipcode”: “90402”, “city”: “Nürnberg”, “country”: “Germany”
officePhoneNumber	+49 176 04069019
emailAddress	post@christian-krause.example.org
givenName	Christian
familyName	Krause
birthday	1954-05-11

Person: Hostsharing eG

HTTP GET "/api/hs/office/persons?name=Hostsharing+eG" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY"
=> status: 200 OK 
[ {
  "uuid" : "0ef98191-79d8-443e-89c1-1076e8f6df80", // Person: Hostsharing eG
  "personType" : "LEGAL_PERSON",
  "tradeName" : "Hostsharing eG",
  "salutation" : null,
  "title" : null,
  "givenName" : null,
  "familyName" : null
} ]

Even in production data we expect this query to return just a single result.

Person: Christian Krause

HTTP POST "/api/hs/office/persons" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY" \
  <<EOF
{
  "personType" : "NATURAL_PERSON",
  "givenName" : "Christian",
  "familyName" : "Krause"
}
EOF
=> status: 201 CREATED 12ebf5cc-5286-48c8-8af5-ca72fde35b5a

Contact: Christian Krause - Hauptkontakt (P-90001)

HTTP POST "/api/hs/office/contacts" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY" \
  <<EOF
{
  "caption" : "Christian Krause - Hauptkontakt (P-90001)",
  "postalAddress" : {
    "name" : "Buchhaltung",
    "street" : "Kirschblütenweg 603",
    "zipcode" : "90402",
    "city" : "Nürnberg",
    "country" : "Germany"
  },
  "phoneNumbers" : {
    "office" : "+49 176 04069019"
  },
  "emailAddresses" : {
    "main" : "post@christian-krause.example.org"
  }
}
EOF
=> status: 201 CREATED fbb8dc1b-197f-404b-8da2-a266fe4aa76c

Create Partner: P-90001 - Christian Krause

HTTP POST "/api/hs/office/partners" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY" \
  <<EOF
{
  "partnerNumber" : "P-90001",
  "partnerRel" : {
    "anchor.uuid" : "0ef98191-79d8-443e-89c1-1076e8f6df80", // Person: Hostsharing eG
    "holder.uuid" : "12ebf5cc-5286-48c8-8af5-ca72fde35b5a", // Person: Christian Krause
    "contact.uuid" : "fbb8dc1b-197f-404b-8da2-a266fe4aa76c" // Contact: Christian Krause - Hauptkontakt (P-90001)
  },
  "details" : {
    "birthday" : "1954-05-11"
  }
}
EOF
=> status: 201 CREATED 26bba594-3e18-45d7-b356-e06a0f3a55b1

Verify the New Partner Relation

HTTP GET "/api/hs/office/relations?relationType=PARTNER&contactData=Christian+Krause+-+Hauptkontakt+%28P-90001%29" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY"
=> status: 200 OK 
[ {
  "uuid" : "13b8695d-69b6-42d7-a4a7-fcc599099938",
  "anchor" : {
    "uuid" : "0ef98191-79d8-443e-89c1-1076e8f6df80", // Person: Hostsharing eG
    "personType" : "LEGAL_PERSON",
    "tradeName" : "Hostsharing eG",
    "salutation" : null,
    "title" : null,
    "givenName" : null,
    "familyName" : null
  },
  "holder" : {
    "uuid" : "12ebf5cc-5286-48c8-8af5-ca72fde35b5a", // Person: Christian Krause
    "personType" : "NATURAL_PERSON",
    "tradeName" : null,
    "salutation" : null,
    "title" : null,
    "givenName" : "Christian",
    "familyName" : "Krause"
  },
  "type" : "PARTNER",
  "mark" : null,
  "contact" : {
    "uuid" : "fbb8dc1b-197f-404b-8da2-a266fe4aa76c", // Contact: Christian Krause - Hauptkontakt (P-90001)
    "caption" : "Christian Krause - Hauptkontakt (P-90001)",
    "postalAddress" : {
      "zipcode" : "90402",
      "country" : "Germany",
      "city" : "Nürnberg",
      "street" : "Kirschblütenweg 603",
      "name" : "Buchhaltung"
    },
    "emailAddresses" : {
      "main" : "post@christian-krause.example.org"
    },
    "phoneNumbers" : {
      "office" : "+49 176 04069019"
    }
  }
} ]

UseCase Create Demo Debitor => Debitor: Christian Krause - Rechnungsstelle (D-9000100)

Properties

Given

name	value
partnerPersonName	Christian Krause
debitorNumberSuffix	00
billable	true
vatBusiness	true
defaultPrefix	aab
bankAccountHolder	Christian Krause (P-90001/0)
iban	DE69990100000452472122
bic	DEMSDEH0
billingContactCaption	Christian Krause - Rechnungsstelle (D-9000100)
billingContactEmailAddress	rechnung0@christian-krause.example.org

BankAccount: Christian Krause (P-90001/0)

HTTP POST "/api/hs/office/bankaccounts" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY" \
  <<EOF
{
  "holder" : "Christian Krause (P-90001/0)",
  "iban" : "DE69990100000452472122",
  "bic" : "DEMSDEH0"
}
EOF
=> status: 201 CREATED 05ab3843-8e8c-4c21-85ef-ba62eb3f30c1

Contact: Christian Krause - Rechnungsstelle (D-9000100)

HTTP POST "/api/hs/office/contacts" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY" \
  <<EOF
{
  "caption" : "Christian Krause - Rechnungsstelle (D-9000100)",
  "emailAddresses" : {
    "main" : "rechnung0@christian-krause.example.org"
  }
}
EOF
=> status: 201 CREATED 9507955c-e761-4dc6-b47a-f1cd6167975f

Create Debitor: Christian Krause - Rechnungsstelle (D-9000100)

HTTP POST "/api/hs/office/debitors" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY" \
  <<EOF
{
  "debitorRel" : {
    "anchor.uuid" : "12ebf5cc-5286-48c8-8af5-ca72fde35b5a", // Person: Christian Krause
    "holder.uuid" : "12ebf5cc-5286-48c8-8af5-ca72fde35b5a", // Person: Christian Krause
    "contact.uuid" : "9507955c-e761-4dc6-b47a-f1cd6167975f" // Contact: Christian Krause - Rechnungsstelle (D-9000100)
  },
  "debitorNumberSuffix" : "00",
  "billable" : true,
  "vatBusiness" : true,
  "vatReverseCharge" : false,
  "refundBankAccount.uuid" : "05ab3843-8e8c-4c21-85ef-ba62eb3f30c1", // BankAccount: Christian Krause (P-90001/0)
  "defaultPrefix" : "aab"
}
EOF
=> status: 201 CREATED d1c1c079-4c40-4aea-a806-6c552ea59ff9

Verify the Debitor Got Created

HTTP GET "/api/hs/office/debitors/d1c1c079-4c40-4aea-a806-6c552ea59ff9" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY"
=> status: 200 OK 
{
  "uuid" : "d1c1c079-4c40-4aea-a806-6c552ea59ff9",
  "debitorRel" : {
    "uuid" : "eb2b4387-5c8a-454c-a2ab-ce02bc344112",
    "anchor" : {
      "uuid" : "12ebf5cc-5286-48c8-8af5-ca72fde35b5a", // Person: Christian Krause
      "personType" : "NATURAL_PERSON",
      "tradeName" : null,
      "salutation" : null,
      "title" : null,
      "givenName" : "Christian",
      "familyName" : "Krause"
    },
    "holder" : {
      "uuid" : "12ebf5cc-5286-48c8-8af5-ca72fde35b5a", // Person: Christian Krause
      "personType" : "NATURAL_PERSON",
      "tradeName" : null,
      "salutation" : null,
      "title" : null,
      "givenName" : "Christian",
      "familyName" : "Krause"
    },
    "type" : "DEBITOR",
    "mark" : null,
    "contact" : {
      "uuid" : "9507955c-e761-4dc6-b47a-f1cd6167975f", // Contact: Christian Krause - Rechnungsstelle (D-9000100)
      "caption" : "Christian Krause - Rechnungsstelle (D-9000100)",
      "postalAddress" : { },
      "emailAddresses" : {
        "main" : "rechnung0@christian-krause.example.org"
      },
      "phoneNumbers" : { }
    }
  },
  "debitorNumber" : "D-9000100",
  "debitorNumberSuffix" : "00",
  "partner" : {
    "uuid" : "26bba594-3e18-45d7-b356-e06a0f3a55b1",
    "partnerNumber" : "P-90001",
    "partnerRel" : {
      "uuid" : "13b8695d-69b6-42d7-a4a7-fcc599099938",
      "anchor" : {
        "uuid" : "0ef98191-79d8-443e-89c1-1076e8f6df80", // Person: Hostsharing eG
        "personType" : "LEGAL_PERSON",
        "tradeName" : "Hostsharing eG",
        "salutation" : null,
        "title" : null,
        "givenName" : null,
        "familyName" : null
      },
      "holder" : {
        "uuid" : "12ebf5cc-5286-48c8-8af5-ca72fde35b5a", // Person: Christian Krause
        "personType" : "NATURAL_PERSON",
        "tradeName" : null,
        "salutation" : null,
        "title" : null,
        "givenName" : "Christian",
        "familyName" : "Krause"
      },
      "type" : "PARTNER",
      "mark" : null,
      "contact" : {
        "uuid" : "fbb8dc1b-197f-404b-8da2-a266fe4aa76c", // Contact: Christian Krause - Hauptkontakt (P-90001)
        "caption" : "Christian Krause - Hauptkontakt (P-90001)",
        "postalAddress" : {
          "zipcode" : "90402",
          "country" : "Germany",
          "city" : "Nürnberg",
          "street" : "Kirschblütenweg 603",
          "name" : "Buchhaltung"
        },
        "emailAddresses" : {
          "main" : "post@christian-krause.example.org"
        },
        "phoneNumbers" : {
          "office" : "+49 176 04069019"
        }
      }
    },
    "details" : {
      "uuid" : "57d996bc-37c9-430a-81f3-701dd63df1d8",
      "registrationOffice" : null,
      "registrationNumber" : null,
      "birthName" : null,
      "birthPlace" : null,
      "birthday" : "1954-05-11",
      "dateOfDeath" : null
    }
  },
  "billable" : true,
  "vatId" : null,
  "vatCountryCode" : null,
  "vatBusiness" : true,
  "vatReverseCharge" : false,
  "refundBankAccount" : {
    "uuid" : "05ab3843-8e8c-4c21-85ef-ba62eb3f30c1", // BankAccount: Christian Krause (P-90001/0)
    "holder" : "Christian Krause (P-90001/0)",
    "iban" : "DE69990100000452472122",
    "bic" : "DEMSDEH0"
  },
  "defaultPrefix" : "aab"
}

UseCase Create Demo Sepa Mandate => SEPA-Mandat: D-9000100-aktuell

Properties

Given

name	value
debitorNumber	D-9000100
mandateReference	D-9000100-aktuell
bankAccountHolder	Christian Krause (P-90001/0/aktuell)
iban	DE34990400000981678500
bic	DEMDDEB0
agreement	2023-07-17
validFrom	2023-07-21

Debitor of D-9000100-aktuell

HTTP GET "/api/hs/office/debitors/D-9000100" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY"
=> status: 200 OK 
{
  "uuid" : "d1c1c079-4c40-4aea-a806-6c552ea59ff9",
  "debitorRel" : {
    "uuid" : "eb2b4387-5c8a-454c-a2ab-ce02bc344112",
    "anchor" : {
      "uuid" : "12ebf5cc-5286-48c8-8af5-ca72fde35b5a", // Person: Christian Krause
      "personType" : "NATURAL_PERSON",
      "tradeName" : null,
      "salutation" : null,
      "title" : null,
      "givenName" : "Christian",
      "familyName" : "Krause"
    },
    "holder" : {
      "uuid" : "12ebf5cc-5286-48c8-8af5-ca72fde35b5a", // Person: Christian Krause
      "personType" : "NATURAL_PERSON",
      "tradeName" : null,
      "salutation" : null,
      "title" : null,
      "givenName" : "Christian",
      "familyName" : "Krause"
    },
    "type" : "DEBITOR",
    "mark" : null,
    "contact" : {
      "uuid" : "9507955c-e761-4dc6-b47a-f1cd6167975f", // Contact: Christian Krause - Rechnungsstelle (D-9000100)
      "caption" : "Christian Krause - Rechnungsstelle (D-9000100)",
      "postalAddress" : { },
      "emailAddresses" : {
        "main" : "rechnung0@christian-krause.example.org"
      },
      "phoneNumbers" : { }
    }
  },
  "debitorNumber" : "D-9000100",
  "debitorNumberSuffix" : "00",
  "partner" : {
    "uuid" : "26bba594-3e18-45d7-b356-e06a0f3a55b1",
    "partnerNumber" : "P-90001",
    "partnerRel" : {
      "uuid" : "13b8695d-69b6-42d7-a4a7-fcc599099938",
      "anchor" : {
        "uuid" : "0ef98191-79d8-443e-89c1-1076e8f6df80", // Person: Hostsharing eG
        "personType" : "LEGAL_PERSON",
        "tradeName" : "Hostsharing eG",
        "salutation" : null,
        "title" : null,
        "givenName" : null,
        "familyName" : null
      },
      "holder" : {
        "uuid" : "12ebf5cc-5286-48c8-8af5-ca72fde35b5a", // Person: Christian Krause
        "personType" : "NATURAL_PERSON",
        "tradeName" : null,
        "salutation" : null,
        "title" : null,
        "givenName" : "Christian",
        "familyName" : "Krause"
      },
      "type" : "PARTNER",
      "mark" : null,
      "contact" : {
        "uuid" : "fbb8dc1b-197f-404b-8da2-a266fe4aa76c", // Contact: Christian Krause - Hauptkontakt (P-90001)
        "caption" : "Christian Krause - Hauptkontakt (P-90001)",
        "postalAddress" : {
          "zipcode" : "90402",
          "country" : "Germany",
          "city" : "Nürnberg",
          "street" : "Kirschblütenweg 603",
          "name" : "Buchhaltung"
        },
        "emailAddresses" : {
          "main" : "post@christian-krause.example.org"
        },
        "phoneNumbers" : {
          "office" : "+49 176 04069019"
        }
      }
    },
    "details" : {
      "uuid" : "57d996bc-37c9-430a-81f3-701dd63df1d8",
      "registrationOffice" : null,
      "registrationNumber" : null,
      "birthName" : null,
      "birthPlace" : null,
      "birthday" : "1954-05-11",
      "dateOfDeath" : null
    }
  },
  "billable" : true,
  "vatId" : null,
  "vatCountryCode" : null,
  "vatBusiness" : true,
  "vatReverseCharge" : false,
  "refundBankAccount" : {
    "uuid" : "05ab3843-8e8c-4c21-85ef-ba62eb3f30c1", // BankAccount: Christian Krause (P-90001/0)
    "holder" : "Christian Krause (P-90001/0)",
    "iban" : "DE69990100000452472122",
    "bic" : "DEMSDEH0"
  },
  "defaultPrefix" : "aab"
}

BankAccount: Christian Krause (P-90001/0/aktuell)

HTTP POST "/api/hs/office/bankaccounts" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY" \
  <<EOF
{
  "holder" : "Christian Krause (P-90001/0/aktuell)",
  "iban" : "DE34990400000981678500",
  "bic" : "DEMDDEB0"
}
EOF
=> status: 201 CREATED 3a7fb4a1-7160-449d-b190-8d74f99a48ee

Create SEPA-Mandat: D-9000100-aktuell

HTTP POST "/api/hs/office/sepamandates" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY" \
  <<EOF
{
  "debitor.uuid" : "d1c1c079-4c40-4aea-a806-6c552ea59ff9", // Debitor of D-9000100-aktuell
  "bankAccount.uuid" : "3a7fb4a1-7160-449d-b190-8d74f99a48ee", // BankAccount: Christian Krause (P-90001/0/aktuell)
  "reference" : "D-9000100-aktuell",
  "agreement" : "2023-07-17",
  "validFrom" : "2023-07-21"
}
EOF
=> status: 201 CREATED 037e8f54-4864-4e69-8020-ea6fa2397be9

Verify the SEPA-Mandate Got Created

HTTP GET "/api/hs/office/sepamandates/037e8f54-4864-4e69-8020-ea6fa2397be9" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY"
=> status: 200 OK 
{
  "uuid" : "037e8f54-4864-4e69-8020-ea6fa2397be9",
  "debitor" : {
    "uuid" : "d1c1c079-4c40-4aea-a806-6c552ea59ff9", // Debitor of D-9000100-aktuell
    "debitorRel" : {
      "uuid" : "eb2b4387-5c8a-454c-a2ab-ce02bc344112",
      "anchor" : {
        "uuid" : "12ebf5cc-5286-48c8-8af5-ca72fde35b5a", // Person: Christian Krause
        "personType" : "NATURAL_PERSON",
        "tradeName" : null,
        "salutation" : null,
        "title" : null,
        "givenName" : "Christian",
        "familyName" : "Krause"
      },
      "holder" : {
        "uuid" : "12ebf5cc-5286-48c8-8af5-ca72fde35b5a", // Person: Christian Krause
        "personType" : "NATURAL_PERSON",
        "tradeName" : null,
        "salutation" : null,
        "title" : null,
        "givenName" : "Christian",
        "familyName" : "Krause"
      },
      "type" : "DEBITOR",
      "mark" : null,
      "contact" : {
        "uuid" : "9507955c-e761-4dc6-b47a-f1cd6167975f", // Contact: Christian Krause - Rechnungsstelle (D-9000100)
        "caption" : "Christian Krause - Rechnungsstelle (D-9000100)",
        "postalAddress" : { },
        "emailAddresses" : {
          "main" : "rechnung0@christian-krause.example.org"
        },
        "phoneNumbers" : { }
      }
    },
    "debitorNumber" : "D-9000100",
    "debitorNumberSuffix" : "00",
    "partner" : {
      "uuid" : "26bba594-3e18-45d7-b356-e06a0f3a55b1",
      "partnerNumber" : "P-90001",
      "partnerRel" : {
        "uuid" : "13b8695d-69b6-42d7-a4a7-fcc599099938",
        "anchor" : {
          "uuid" : "0ef98191-79d8-443e-89c1-1076e8f6df80", // Person: Hostsharing eG
          "personType" : "LEGAL_PERSON",
          "tradeName" : "Hostsharing eG",
          "salutation" : null,
          "title" : null,
          "givenName" : null,
          "familyName" : null
        },
        "holder" : {
          "uuid" : "12ebf5cc-5286-48c8-8af5-ca72fde35b5a", // Person: Christian Krause
          "personType" : "NATURAL_PERSON",
          "tradeName" : null,
          "salutation" : null,
          "title" : null,
          "givenName" : "Christian",
          "familyName" : "Krause"
        },
        "type" : "PARTNER",
        "mark" : null,
        "contact" : {
          "uuid" : "fbb8dc1b-197f-404b-8da2-a266fe4aa76c", // Contact: Christian Krause - Hauptkontakt (P-90001)
          "caption" : "Christian Krause - Hauptkontakt (P-90001)",
          "postalAddress" : {
            "zipcode" : "90402",
            "country" : "Germany",
            "city" : "Nürnberg",
            "street" : "Kirschblütenweg 603",
            "name" : "Buchhaltung"
          },
          "emailAddresses" : {
            "main" : "post@christian-krause.example.org"
          },
          "phoneNumbers" : {
            "office" : "+49 176 04069019"
          }
        }
      },
      "details" : {
        "uuid" : "57d996bc-37c9-430a-81f3-701dd63df1d8",
        "registrationOffice" : null,
        "registrationNumber" : null,
        "birthName" : null,
        "birthPlace" : null,
        "birthday" : "1954-05-11",
        "dateOfDeath" : null
      }
    },
    "billable" : true,
    "vatId" : null,
    "vatCountryCode" : null,
    "vatBusiness" : true,
    "vatReverseCharge" : false,
    "refundBankAccount" : {
      "uuid" : "05ab3843-8e8c-4c21-85ef-ba62eb3f30c1", // BankAccount: Christian Krause (P-90001/0)
      "holder" : "Christian Krause (P-90001/0)",
      "iban" : "DE69990100000452472122",
      "bic" : "DEMSDEH0"
    },
    "defaultPrefix" : "aab"
  },
  "bankAccount" : {
    "uuid" : "3a7fb4a1-7160-449d-b190-8d74f99a48ee", // BankAccount: Christian Krause (P-90001/0/aktuell)
    "holder" : "Christian Krause (P-90001/0/aktuell)",
    "iban" : "DE34990400000981678500",
    "bic" : "DEMDDEB0"
  },
  "reference" : "D-9000100-aktuell",
  "agreement" : "2023-07-17",
  "validFrom" : "2023-07-21",
  "validTo" : null
}

UseCase Create Membership => Membership: Christian Krause

Properties

Given

name	value
partnerNumber	P-90001
validFrom	2008-01-10
membershipFeeBillable	true

Partner: P-90001

HTTP GET "/api/hs/office/partners/P-90001" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY"
=> status: 200 OK 
{
  "uuid" : "26bba594-3e18-45d7-b356-e06a0f3a55b1",
  "partnerNumber" : "P-90001",
  "partnerRel" : {
    "uuid" : "13b8695d-69b6-42d7-a4a7-fcc599099938",
    "anchor" : {
      "uuid" : "0ef98191-79d8-443e-89c1-1076e8f6df80", // Person: Hostsharing eG
      "personType" : "LEGAL_PERSON",
      "tradeName" : "Hostsharing eG",
      "salutation" : null,
      "title" : null,
      "givenName" : null,
      "familyName" : null
    },
    "holder" : {
      "uuid" : "12ebf5cc-5286-48c8-8af5-ca72fde35b5a", // Person: Christian Krause
      "personType" : "NATURAL_PERSON",
      "tradeName" : null,
      "salutation" : null,
      "title" : null,
      "givenName" : "Christian",
      "familyName" : "Krause"
    },
    "type" : "PARTNER",
    "mark" : null,
    "contact" : {
      "uuid" : "fbb8dc1b-197f-404b-8da2-a266fe4aa76c", // Contact: Christian Krause - Hauptkontakt (P-90001)
      "caption" : "Christian Krause - Hauptkontakt (P-90001)",
      "postalAddress" : {
        "zipcode" : "90402",
        "country" : "Germany",
        "city" : "Nürnberg",
        "street" : "Kirschblütenweg 603",
        "name" : "Buchhaltung"
      },
      "emailAddresses" : {
        "main" : "post@christian-krause.example.org"
      },
      "phoneNumbers" : {
        "office" : "+49 176 04069019"
      }
    }
  },
  "details" : {
    "uuid" : "57d996bc-37c9-430a-81f3-701dd63df1d8",
    "registrationOffice" : null,
    "registrationNumber" : null,
    "birthName" : null,
    "birthPlace" : null,
    "birthday" : "1954-05-11",
    "dateOfDeath" : null
  }
}

The partner-number identifies the partner; a lookup by name could not, because a natural person carries its name in two columns and any name can be the prefix of a longer one.

Create Membership: Christian Krause

HTTP POST "/api/hs/office/memberships" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY" \
  <<EOF
{
  "partner.uuid" : "26bba594-3e18-45d7-b356-e06a0f3a55b1", // Partner: P-90001
  "memberNumberSuffix" : "00",
  "status" : "ACTIVE",
  "validFrom" : "2008-01-10",
  "membershipFeeBillable" : true
}
EOF
=> status: 201 CREATED be0847b1-1362-47c3-a962-68a43e7d6821

Verify That the Membership Got Created

HTTP GET "/api/hs/office/memberships/be0847b1-1362-47c3-a962-68a43e7d6821" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY"
=> status: 200 OK 
{
  "uuid" : "be0847b1-1362-47c3-a962-68a43e7d6821",
  "partner" : {
    "uuid" : "26bba594-3e18-45d7-b356-e06a0f3a55b1", // Partner: P-90001
    "partnerNumber" : "P-90001",
    "partnerRel" : {
      "uuid" : "13b8695d-69b6-42d7-a4a7-fcc599099938",
      "anchor" : {
        "uuid" : "0ef98191-79d8-443e-89c1-1076e8f6df80", // Person: Hostsharing eG
        "personType" : "LEGAL_PERSON",
        "tradeName" : "Hostsharing eG",
        "salutation" : null,
        "title" : null,
        "givenName" : null,
        "familyName" : null
      },
      "holder" : {
        "uuid" : "12ebf5cc-5286-48c8-8af5-ca72fde35b5a", // Person: Christian Krause
        "personType" : "NATURAL_PERSON",
        "tradeName" : null,
        "salutation" : null,
        "title" : null,
        "givenName" : "Christian",
        "familyName" : "Krause"
      },
      "type" : "PARTNER",
      "mark" : null,
      "contact" : {
        "uuid" : "fbb8dc1b-197f-404b-8da2-a266fe4aa76c", // Contact: Christian Krause - Hauptkontakt (P-90001)
        "caption" : "Christian Krause - Hauptkontakt (P-90001)",
        "postalAddress" : {
          "zipcode" : "90402",
          "country" : "Germany",
          "city" : "Nürnberg",
          "street" : "Kirschblütenweg 603",
          "name" : "Buchhaltung"
        },
        "emailAddresses" : {
          "main" : "post@christian-krause.example.org"
        },
        "phoneNumbers" : {
          "office" : "+49 176 04069019"
        }
      }
    },
    "details" : {
      "uuid" : "57d996bc-37c9-430a-81f3-701dd63df1d8",
      "registrationOffice" : null,
      "registrationNumber" : null,
      "birthName" : null,
      "birthPlace" : null,
      "birthday" : "1954-05-11",
      "dateOfDeath" : null
    }
  },
  "mainDebitor" : null,
  "memberNumber" : "M-9000100",
  "memberNumberSuffix" : "00",
  "validFrom" : "2008-01-10",
  "validTo" : null,
  "status" : "ACTIVE",
  "membershipFeeBillable" : true
}

Properties

Given

name	value
transactionType	SUBSCRIPTION
memberNumber	M-9000100
reference	sign 2008-01-10
shareCount	32
comment	initial shares on joining
transactionDate	2008-01-10

Find membershipUuid

HTTP GET "/api/hs/office/memberships/M-9000100" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY"
=> status: 200 OK 
{
  "uuid" : "be0847b1-1362-47c3-a962-68a43e7d6821",
  "partner" : {
    "uuid" : "26bba594-3e18-45d7-b356-e06a0f3a55b1", // Partner: P-90001
    "partnerNumber" : "P-90001",
    "partnerRel" : {
      "uuid" : "13b8695d-69b6-42d7-a4a7-fcc599099938",
      "anchor" : {
        "uuid" : "0ef98191-79d8-443e-89c1-1076e8f6df80", // Person: Hostsharing eG
        "personType" : "LEGAL_PERSON",
        "tradeName" : "Hostsharing eG",
        "salutation" : null,
        "title" : null,
        "givenName" : null,
        "familyName" : null
      },
      "holder" : {
        "uuid" : "12ebf5cc-5286-48c8-8af5-ca72fde35b5a", // Person: Christian Krause
        "personType" : "NATURAL_PERSON",
        "tradeName" : null,
        "salutation" : null,
        "title" : null,
        "givenName" : "Christian",
        "familyName" : "Krause"
      },
      "type" : "PARTNER",
      "mark" : null,
      "contact" : {
        "uuid" : "fbb8dc1b-197f-404b-8da2-a266fe4aa76c", // Contact: Christian Krause - Hauptkontakt (P-90001)
        "caption" : "Christian Krause - Hauptkontakt (P-90001)",
        "postalAddress" : {
          "zipcode" : "90402",
          "country" : "Germany",
          "city" : "Nürnberg",
          "street" : "Kirschblütenweg 603",
          "name" : "Buchhaltung"
        },
        "emailAddresses" : {
          "main" : "post@christian-krause.example.org"
        },
        "phoneNumbers" : {
          "office" : "+49 176 04069019"
        }
      }
    },
    "details" : {
      "uuid" : "57d996bc-37c9-430a-81f3-701dd63df1d8",
      "registrationOffice" : null,
      "registrationNumber" : null,
      "birthName" : null,
      "birthPlace" : null,
      "birthday" : "1954-05-11",
      "dateOfDeath" : null
    }
  },
  "mainDebitor" : null,
  "memberNumber" : "M-9000100",
  "memberNumberSuffix" : "00",
  "validFrom" : "2008-01-10",
  "validTo" : null,
  "status" : "ACTIVE",
  "membershipFeeBillable" : true
}

Create the Coop-Shares-SUBSCRIPTION Transaction

HTTP POST "/api/hs/office/coopsharestransactions" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY" \
  <<EOF
{
  "membership.uuid" : "be0847b1-1362-47c3-a962-68a43e7d6821", // membershipUuid
  "transactionType" : "SUBSCRIPTION",
  "reference" : "sign 2008-01-10",
  "shareCount" : 32,
  "comment" : "initial shares on joining",
  "valueDate" : "2008-01-10"
}
EOF
=> status: 201 CREATED 4a77b957-41d2-4c71-acdd-e4d2754ae8b9

Verify Coop-Shares SUBSCRIPTION-Transaction

HTTP GET "/api/hs/office/coopsharestransactions/4a77b957-41d2-4c71-acdd-e4d2754ae8b9" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY"
=> status: 200 OK 
{
  "uuid" : "4a77b957-41d2-4c71-acdd-e4d2754ae8b9",
  "membership.uuid" : "be0847b1-1362-47c3-a962-68a43e7d6821", // membershipUuid
  "transactionType" : "SUBSCRIPTION",
  "shareCount" : 32,
  "valueDate" : "2008-01-10",
  "reference" : "sign 2008-01-10",
  "comment" : "initial shares on joining",
  "revertedShareTx" : null,
  "reversalShareTx" : null
}

Properties

Given

name	value
transactionType	DEPOSIT
memberNumber	M-9000100
reference	sign 2008-01-10
assetValue	2048
comment	deposit for initial shares
transactionDate	2008-01-15

Find membershipUuid

HTTP GET "/api/hs/office/memberships/M-9000100" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY"
=> status: 200 OK 
{
  "uuid" : "be0847b1-1362-47c3-a962-68a43e7d6821", // membershipUuid
  "partner" : {
    "uuid" : "26bba594-3e18-45d7-b356-e06a0f3a55b1", // Partner: P-90001
    "partnerNumber" : "P-90001",
    "partnerRel" : {
      "uuid" : "13b8695d-69b6-42d7-a4a7-fcc599099938",
      "anchor" : {
        "uuid" : "0ef98191-79d8-443e-89c1-1076e8f6df80", // Person: Hostsharing eG
        "personType" : "LEGAL_PERSON",
        "tradeName" : "Hostsharing eG",
        "salutation" : null,
        "title" : null,
        "givenName" : null,
        "familyName" : null
      },
      "holder" : {
        "uuid" : "12ebf5cc-5286-48c8-8af5-ca72fde35b5a", // Person: Christian Krause
        "personType" : "NATURAL_PERSON",
        "tradeName" : null,
        "salutation" : null,
        "title" : null,
        "givenName" : "Christian",
        "familyName" : "Krause"
      },
      "type" : "PARTNER",
      "mark" : null,
      "contact" : {
        "uuid" : "fbb8dc1b-197f-404b-8da2-a266fe4aa76c", // Contact: Christian Krause - Hauptkontakt (P-90001)
        "caption" : "Christian Krause - Hauptkontakt (P-90001)",
        "postalAddress" : {
          "zipcode" : "90402",
          "country" : "Germany",
          "city" : "Nürnberg",
          "street" : "Kirschblütenweg 603",
          "name" : "Buchhaltung"
        },
        "emailAddresses" : {
          "main" : "post@christian-krause.example.org"
        },
        "phoneNumbers" : {
          "office" : "+49 176 04069019"
        }
      }
    },
    "details" : {
      "uuid" : "57d996bc-37c9-430a-81f3-701dd63df1d8",
      "registrationOffice" : null,
      "registrationNumber" : null,
      "birthName" : null,
      "birthPlace" : null,
      "birthday" : "1954-05-11",
      "dateOfDeath" : null
    }
  },
  "mainDebitor" : null,
  "memberNumber" : "M-9000100",
  "memberNumberSuffix" : "00",
  "validFrom" : "2008-01-10",
  "validTo" : null,
  "status" : "ACTIVE",
  "membershipFeeBillable" : true
}

Create the Coop-Assets-DEPOSIT Transaction

HTTP POST "/api/hs/office/coopassetstransactions" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY" \
  <<EOF
{
  "membership.uuid" : "be0847b1-1362-47c3-a962-68a43e7d6821", // membershipUuid
  "transactionType" : "DEPOSIT",
  "reference" : "sign 2008-01-10",
  "assetValue" : 2048,
  "comment" : "deposit for initial shares",
  "valueDate" : "2008-01-15"
}
EOF
=> status: 201 CREATED 21314338-4a67-4346-a70e-799aac4371b4

Verify Coop-Assets DEPOSIT-Transaction

HTTP GET "/api/hs/office/coopassetstransactions/21314338-4a67-4346-a70e-799aac4371b4" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY"
=> status: 200 OK 
{
  "uuid" : "21314338-4a67-4346-a70e-799aac4371b4",
  "membership.uuid" : "be0847b1-1362-47c3-a962-68a43e7d6821", // membershipUuid
  "membership.memberNumber" : "M-9000100",
  "transactionType" : "DEPOSIT",
  "assetValue" : 2048,
  "valueDate" : "2008-01-15",
  "reference" : "sign 2008-01-10",
  "comment" : "deposit for initial shares",
  "adoptionAssetTx" : null,
  "transferAssetTx" : null,
  "revertedAssetTx" : null,
  "reversalAssetTx" : null
}

UseCase Add Demo Subscription => SUBSCRIBER generalversammlung: Christian Krause (P-90001)

Properties

Given

name	value
partnerPersonName	Christian Krause
mailingList	generalversammlung
holderGivenName	Christian
holderFamilyName	Krause
contactCaption	Christian Krause - Hauptkontakt (P-90001)

Create SUBSCRIBER generalversammlung: Christian Krause (P-90001)

HTTP POST "/api/hs/office/relations" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY" \
  <<EOF
{
  "type" : "SUBSCRIBER",
  "mark" : "generalversammlung",
  "anchor.uuid" : "12ebf5cc-5286-48c8-8af5-ca72fde35b5a", // Person: Christian Krause
  "holder.uuid" : "12ebf5cc-5286-48c8-8af5-ca72fde35b5a", // Person: Christian Krause
  "contact.uuid" : "fbb8dc1b-197f-404b-8da2-a266fe4aa76c" // Contact: Christian Krause - Hauptkontakt (P-90001)
}
EOF
=> status: 201 CREATED 4a827429-64e6-491f-ba29-b846d13240ff

Verify the Subscription Got Created

HTTP GET "/api/hs/office/relations/4a827429-64e6-491f-ba29-b846d13240ff" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY"
=> status: 200 OK 
{
  "uuid" : "4a827429-64e6-491f-ba29-b846d13240ff",
  "anchor" : {
    "uuid" : "12ebf5cc-5286-48c8-8af5-ca72fde35b5a", // Person: Christian Krause
    "personType" : "NATURAL_PERSON",
    "tradeName" : null,
    "salutation" : null,
    "title" : null,
    "givenName" : "Christian",
    "familyName" : "Krause"
  },
  "holder" : {
    "uuid" : "12ebf5cc-5286-48c8-8af5-ca72fde35b5a", // Person: Christian Krause
    "personType" : "NATURAL_PERSON",
    "tradeName" : null,
    "salutation" : null,
    "title" : null,
    "givenName" : "Christian",
    "familyName" : "Krause"
  },
  "type" : "SUBSCRIBER",
  "mark" : "generalversammlung",
  "contact" : {
    "uuid" : "fbb8dc1b-197f-404b-8da2-a266fe4aa76c", // Contact: Christian Krause - Hauptkontakt (P-90001)
    "caption" : "Christian Krause - Hauptkontakt (P-90001)",
    "postalAddress" : {
      "zipcode" : "90402",
      "country" : "Germany",
      "city" : "Nürnberg",
      "street" : "Kirschblütenweg 603",
      "name" : "Buchhaltung"
    },
    "emailAddresses" : {
      "main" : "post@christian-krause.example.org"
    },
    "phoneNumbers" : {
      "office" : "+49 176 04069019"
    }
  }
}

UseCase Add Demo Subscription => SUBSCRIBER customers-announce: Christian Krause (P-90001)

Properties

Given

name	value
partnerPersonName	Christian Krause
mailingList	customers-announce
holderGivenName	Christian
holderFamilyName	Krause
contactCaption	Christian Krause - Hauptkontakt (P-90001)

Create SUBSCRIBER customers-announce: Christian Krause (P-90001)

HTTP POST "/api/hs/office/relations" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY" \
  <<EOF
{
  "type" : "SUBSCRIBER",
  "mark" : "customers-announce",
  "anchor.uuid" : "12ebf5cc-5286-48c8-8af5-ca72fde35b5a", // Person: Christian Krause
  "holder.uuid" : "12ebf5cc-5286-48c8-8af5-ca72fde35b5a", // Person: Christian Krause
  "contact.uuid" : "fbb8dc1b-197f-404b-8da2-a266fe4aa76c" // Contact: Christian Krause - Hauptkontakt (P-90001)
}
EOF
=> status: 201 CREATED 8cb2ffa0-a4b9-4edd-aebd-150ed48ab2a7

Verify the Subscription Got Created

HTTP GET "/api/hs/office/relations/8cb2ffa0-a4b9-4edd-aebd-150ed48ab2a7" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY"
=> status: 200 OK 
{
  "uuid" : "8cb2ffa0-a4b9-4edd-aebd-150ed48ab2a7",
  "anchor" : {
    "uuid" : "12ebf5cc-5286-48c8-8af5-ca72fde35b5a", // Person: Christian Krause
    "personType" : "NATURAL_PERSON",
    "tradeName" : null,
    "salutation" : null,
    "title" : null,
    "givenName" : "Christian",
    "familyName" : "Krause"
  },
  "holder" : {
    "uuid" : "12ebf5cc-5286-48c8-8af5-ca72fde35b5a", // Person: Christian Krause
    "personType" : "NATURAL_PERSON",
    "tradeName" : null,
    "salutation" : null,
    "title" : null,
    "givenName" : "Christian",
    "familyName" : "Krause"
  },
  "type" : "SUBSCRIBER",
  "mark" : "customers-announce",
  "contact" : {
    "uuid" : "fbb8dc1b-197f-404b-8da2-a266fe4aa76c", // Contact: Christian Krause - Hauptkontakt (P-90001)
    "caption" : "Christian Krause - Hauptkontakt (P-90001)",
    "postalAddress" : {
      "zipcode" : "90402",
      "country" : "Germany",
      "city" : "Nürnberg",
      "street" : "Kirschblütenweg 603",
      "name" : "Buchhaltung"
    },
    "emailAddresses" : {
      "main" : "post@christian-krause.example.org"
    },
    "phoneNumbers" : {
      "office" : "+49 176 04069019"
    }
  }
}

UseCase Add Demo Subscription => SUBSCRIBER operations-announce: Christian Krause (P-90001)

Properties

Given

name	value
partnerPersonName	Christian Krause
mailingList	operations-announce
holderGivenName	Christian
holderFamilyName	Krause
contactCaption	Christian Krause - Hauptkontakt (P-90001)

Create SUBSCRIBER operations-announce: Christian Krause (P-90001)

HTTP POST "/api/hs/office/relations" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY" \
  <<EOF
{
  "type" : "SUBSCRIBER",
  "mark" : "operations-announce",
  "anchor.uuid" : "12ebf5cc-5286-48c8-8af5-ca72fde35b5a", // Person: Christian Krause
  "holder.uuid" : "12ebf5cc-5286-48c8-8af5-ca72fde35b5a", // Person: Christian Krause
  "contact.uuid" : "fbb8dc1b-197f-404b-8da2-a266fe4aa76c" // Contact: Christian Krause - Hauptkontakt (P-90001)
}
EOF
=> status: 201 CREATED 2d7d4126-29d2-4a78-83ae-e3f1d8b31761

Verify the Subscription Got Created

HTTP GET "/api/hs/office/relations/2d7d4126-29d2-4a78-83ae-e3f1d8b31761" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY"
=> status: 200 OK 
{
  "uuid" : "2d7d4126-29d2-4a78-83ae-e3f1d8b31761",
  "anchor" : {
    "uuid" : "12ebf5cc-5286-48c8-8af5-ca72fde35b5a", // Person: Christian Krause
    "personType" : "NATURAL_PERSON",
    "tradeName" : null,
    "salutation" : null,
    "title" : null,
    "givenName" : "Christian",
    "familyName" : "Krause"
  },
  "holder" : {
    "uuid" : "12ebf5cc-5286-48c8-8af5-ca72fde35b5a", // Person: Christian Krause
    "personType" : "NATURAL_PERSON",
    "tradeName" : null,
    "salutation" : null,
    "title" : null,
    "givenName" : "Christian",
    "familyName" : "Krause"
  },
  "type" : "SUBSCRIBER",
  "mark" : "operations-announce",
  "contact" : {
    "uuid" : "fbb8dc1b-197f-404b-8da2-a266fe4aa76c", // Contact: Christian Krause - Hauptkontakt (P-90001)
    "caption" : "Christian Krause - Hauptkontakt (P-90001)",
    "postalAddress" : {
      "zipcode" : "90402",
      "country" : "Germany",
      "city" : "Nürnberg",
      "street" : "Kirschblütenweg 603",
      "name" : "Buchhaltung"
    },
    "emailAddresses" : {
      "main" : "post@christian-krause.example.org"
    },
    "phoneNumbers" : {
      "office" : "+49 176 04069019"
    }
  }
}

UseCase Create Partner => Partner: P-90002 - Fischer Pflege GmbH

Properties

Given

name	value
partnerNumber	P-90002
personType	LEGAL_PERSON
contactCaption	Fischer Pflege GmbH - Hauptkontakt (P-90002)
postalAddress	“street”: “Bachstraße 553”, “zipcode”: “28195”, “city”: “Bremen”, “country”: “Germany”
officePhoneNumber	+49 171 3920003
emailAddress	info@fischer-pflege-gmbh.example.org
tradeName	Fischer Pflege GmbH
registrationOffice	Registergericht Bremen
registrationNumber	310659

Person: Hostsharing eG

HTTP GET "/api/hs/office/persons?name=Hostsharing+eG" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY"
=> status: 200 OK 
[ {
  "uuid" : "0ef98191-79d8-443e-89c1-1076e8f6df80", // Person: Hostsharing eG
  "personType" : "LEGAL_PERSON",
  "tradeName" : "Hostsharing eG",
  "salutation" : null,
  "title" : null,
  "givenName" : null,
  "familyName" : null
} ]

Even in production data we expect this query to return just a single result.

Person: Fischer Pflege GmbH

HTTP POST "/api/hs/office/persons" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY" \
  <<EOF
{
  "personType" : "LEGAL_PERSON",
  "tradeName" : "Fischer Pflege GmbH"
}
EOF
=> status: 201 CREATED 6cb14931-a2c8-4bc4-ad64-46e89411f011

Contact: Fischer Pflege GmbH - Hauptkontakt (P-90002)

HTTP POST "/api/hs/office/contacts" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY" \
  <<EOF
{
  "caption" : "Fischer Pflege GmbH - Hauptkontakt (P-90002)",
  "postalAddress" : {
    "street" : "Bachstraße 553",
    "zipcode" : "28195",
    "city" : "Bremen",
    "country" : "Germany"
  },
  "phoneNumbers" : {
    "office" : "+49 171 3920003"
  },
  "emailAddresses" : {
    "main" : "info@fischer-pflege-gmbh.example.org"
  }
}
EOF
=> status: 201 CREATED 43420671-aeed-4bd7-979a-6d8963e1dd8b

Create Partner: P-90002 - Fischer Pflege GmbH

HTTP POST "/api/hs/office/partners" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY" \
  <<EOF
{
  "partnerNumber" : "P-90002",
  "partnerRel" : {
    "anchor.uuid" : "0ef98191-79d8-443e-89c1-1076e8f6df80", // Person: Hostsharing eG
    "holder.uuid" : "6cb14931-a2c8-4bc4-ad64-46e89411f011", // Person: Fischer Pflege GmbH
    "contact.uuid" : "43420671-aeed-4bd7-979a-6d8963e1dd8b" // Contact: Fischer Pflege GmbH - Hauptkontakt (P-90002)
  },
  "details" : {
    "registrationOffice" : "Registergericht Bremen",
    "registrationNumber" : "310659"
  }
}
EOF
=> status: 201 CREATED a6e52f79-7927-4f55-83b2-84e51615ea91

Verify the New Partner Relation

HTTP GET "/api/hs/office/relations?relationType=PARTNER&contactData=Fischer+Pflege+GmbH+-+Hauptkontakt+%28P-90002%29" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY"
=> status: 200 OK 
[ {
  "uuid" : "506e77d7-e2c4-494d-a268-28b1c2d1f298",
  "anchor" : {
    "uuid" : "0ef98191-79d8-443e-89c1-1076e8f6df80", // Person: Hostsharing eG
    "personType" : "LEGAL_PERSON",
    "tradeName" : "Hostsharing eG",
    "salutation" : null,
    "title" : null,
    "givenName" : null,
    "familyName" : null
  },
  "holder" : {
    "uuid" : "6cb14931-a2c8-4bc4-ad64-46e89411f011", // Person: Fischer Pflege GmbH
    "personType" : "LEGAL_PERSON",
    "tradeName" : "Fischer Pflege GmbH",
    "salutation" : null,
    "title" : null,
    "givenName" : null,
    "familyName" : null
  },
  "type" : "PARTNER",
  "mark" : null,
  "contact" : {
    "uuid" : "43420671-aeed-4bd7-979a-6d8963e1dd8b", // Contact: Fischer Pflege GmbH - Hauptkontakt (P-90002)
    "caption" : "Fischer Pflege GmbH - Hauptkontakt (P-90002)",
    "postalAddress" : {
      "zipcode" : "28195",
      "country" : "Germany",
      "city" : "Bremen",
      "street" : "Bachstraße 553"
    },
    "emailAddresses" : {
      "main" : "info@fischer-pflege-gmbh.example.org"
    },
    "phoneNumbers" : {
      "office" : "+49 171 3920003"
    }
  }
} ]

UseCase Add Demo Relation => REPRESENTATIVE: Daniel Fischer - Vertretung (P-90002)

Properties

Given

name	value
partnerPersonName	Fischer Pflege GmbH
relationType	REPRESENTATIVE
holderGivenName	Daniel
holderFamilyName	Fischer
contactCaption	Daniel Fischer - Vertretung (P-90002)
postalAddress	“name”: “Rechnungsstelle”, “street”: “Dorfstraße 882”, “zipcode”: “50667”, “city”: “Köln”, “country”: “Germany”
phoneNumber	+49 221 4710601
emailAddress	daniel-fischer@fischer-pflege-gmbh.example.org

Person: Daniel Fischer

HTTP POST "/api/hs/office/persons" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY" \
  <<EOF
{
  "personType" : "NATURAL_PERSON",
  "familyName" : "Fischer",
  "givenName" : "Daniel"
}
EOF
=> status: 201 CREATED bcf825af-0787-4e8e-b901-71397c604f48

Contact: Daniel Fischer - Vertretung (P-90002)

HTTP POST "/api/hs/office/contacts" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY" \
  <<EOF
{
  "caption" : "Daniel Fischer - Vertretung (P-90002)",
  "postalAddress" : {
    "name" : "Rechnungsstelle",
    "street" : "Dorfstraße 882",
    "zipcode" : "50667",
    "city" : "Köln",
    "country" : "Germany"
  },
  "phoneNumbers" : {
    "office" : "+49 221 4710601"
  },
  "emailAddresses" : {
    "main" : "daniel-fischer@fischer-pflege-gmbh.example.org"
  }
}
EOF
=> status: 201 CREATED 85666d56-2436-4182-8c29-cf4576083b3a

Create REPRESENTATIVE: Daniel Fischer - Vertretung (P-90002)

HTTP POST "/api/hs/office/relations" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY" \
  <<EOF
{
  "type" : "REPRESENTATIVE",
  "anchor.uuid" : "6cb14931-a2c8-4bc4-ad64-46e89411f011", // Person: Fischer Pflege GmbH
  "holder.uuid" : "bcf825af-0787-4e8e-b901-71397c604f48", // Person: Daniel Fischer
  "contact.uuid" : "85666d56-2436-4182-8c29-cf4576083b3a" // Contact: Daniel Fischer - Vertretung (P-90002)
}
EOF
=> status: 201 CREATED 2f3539d3-1bb7-4e27-b016-a9f1765e2d6e

Verify the Relation Got Created

HTTP GET "/api/hs/office/relations/2f3539d3-1bb7-4e27-b016-a9f1765e2d6e" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY"
=> status: 200 OK 
{
  "uuid" : "2f3539d3-1bb7-4e27-b016-a9f1765e2d6e",
  "anchor" : {
    "uuid" : "6cb14931-a2c8-4bc4-ad64-46e89411f011", // Person: Fischer Pflege GmbH
    "personType" : "LEGAL_PERSON",
    "tradeName" : "Fischer Pflege GmbH",
    "salutation" : null,
    "title" : null,
    "givenName" : null,
    "familyName" : null
  },
  "holder" : {
    "uuid" : "bcf825af-0787-4e8e-b901-71397c604f48", // Person: Daniel Fischer
    "personType" : "NATURAL_PERSON",
    "tradeName" : null,
    "salutation" : null,
    "title" : null,
    "givenName" : "Daniel",
    "familyName" : "Fischer"
  },
  "type" : "REPRESENTATIVE",
  "mark" : null,
  "contact" : {
    "uuid" : "85666d56-2436-4182-8c29-cf4576083b3a", // Contact: Daniel Fischer - Vertretung (P-90002)
    "caption" : "Daniel Fischer - Vertretung (P-90002)",
    "postalAddress" : {
      "zipcode" : "50667",
      "country" : "Germany",
      "city" : "Köln",
      "street" : "Dorfstraße 882",
      "name" : "Rechnungsstelle"
    },
    "emailAddresses" : {
      "main" : "daniel-fischer@fischer-pflege-gmbh.example.org"
    },
    "phoneNumbers" : {
      "office" : "+49 221 4710601"
    }
  }
}

UseCase Add Demo Relation => OPERATIONS: Detlef Keller - Technik (P-90002)

Properties

Given

name	value
partnerPersonName	Fischer Pflege GmbH
relationType	OPERATIONS
holderGivenName	Detlef
holderFamilyName	Keller
contactCaption	Detlef Keller - Technik (P-90002)
postalAddress	“name”: “Rechnungsstelle”, “street”: “Goethestraße 288”, “zipcode”: “53111”, “city”: “Bonn”, “country”: “Germany”
phoneNumber	+49 171 3920098
emailAddress	detlef-keller@fischer-pflege-gmbh.example.org

Person: Detlef Keller

HTTP POST "/api/hs/office/persons" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY" \
  <<EOF
{
  "personType" : "NATURAL_PERSON",
  "familyName" : "Keller",
  "givenName" : "Detlef"
}
EOF
=> status: 201 CREATED 1f4d12f9-9c36-44ce-856b-f784e6b33126

Contact: Detlef Keller - Technik (P-90002)

HTTP POST "/api/hs/office/contacts" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY" \
  <<EOF
{
  "caption" : "Detlef Keller - Technik (P-90002)",
  "postalAddress" : {
    "name" : "Rechnungsstelle",
    "street" : "Goethestraße 288",
    "zipcode" : "53111",
    "city" : "Bonn",
    "country" : "Germany"
  },
  "phoneNumbers" : {
    "office" : "+49 171 3920098"
  },
  "emailAddresses" : {
    "main" : "detlef-keller@fischer-pflege-gmbh.example.org"
  }
}
EOF
=> status: 201 CREATED fa7b8d0a-6f38-4f3a-ac8d-6acb49531f99

Create OPERATIONS: Detlef Keller - Technik (P-90002)

HTTP POST "/api/hs/office/relations" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY" \
  <<EOF
{
  "type" : "OPERATIONS",
  "anchor.uuid" : "6cb14931-a2c8-4bc4-ad64-46e89411f011", // Person: Fischer Pflege GmbH
  "holder.uuid" : "1f4d12f9-9c36-44ce-856b-f784e6b33126", // Person: Detlef Keller
  "contact.uuid" : "fa7b8d0a-6f38-4f3a-ac8d-6acb49531f99" // Contact: Detlef Keller - Technik (P-90002)
}
EOF
=> status: 201 CREATED 01393404-4c90-4428-bdf0-f0003a71dec1

Verify the Relation Got Created

HTTP GET "/api/hs/office/relations/01393404-4c90-4428-bdf0-f0003a71dec1" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY"
=> status: 200 OK 
{
  "uuid" : "01393404-4c90-4428-bdf0-f0003a71dec1",
  "anchor" : {
    "uuid" : "6cb14931-a2c8-4bc4-ad64-46e89411f011", // Person: Fischer Pflege GmbH
    "personType" : "LEGAL_PERSON",
    "tradeName" : "Fischer Pflege GmbH",
    "salutation" : null,
    "title" : null,
    "givenName" : null,
    "familyName" : null
  },
  "holder" : {
    "uuid" : "1f4d12f9-9c36-44ce-856b-f784e6b33126", // Person: Detlef Keller
    "personType" : "NATURAL_PERSON",
    "tradeName" : null,
    "salutation" : null,
    "title" : null,
    "givenName" : "Detlef",
    "familyName" : "Keller"
  },
  "type" : "OPERATIONS",
  "mark" : null,
  "contact" : {
    "uuid" : "fa7b8d0a-6f38-4f3a-ac8d-6acb49531f99", // Contact: Detlef Keller - Technik (P-90002)
    "caption" : "Detlef Keller - Technik (P-90002)",
    "postalAddress" : {
      "zipcode" : "53111",
      "country" : "Germany",
      "city" : "Bonn",
      "street" : "Goethestraße 288",
      "name" : "Rechnungsstelle"
    },
    "emailAddresses" : {
      "main" : "detlef-keller@fischer-pflege-gmbh.example.org"
    },
    "phoneNumbers" : {
      "office" : "+49 171 3920098"
    }
  }
}

UseCase Add Demo Relation => OPERATIONS: Doris Schneider - Technik (P-90002)

Properties

Given

name	value
partnerPersonName	Fischer Pflege GmbH
relationType	OPERATIONS
holderGivenName	Doris
holderFamilyName	Schneider
contactCaption	Doris Schneider - Technik (P-90002)
postalAddress	“street”: “Nelkenweg 142”, “zipcode”: “80331”, “city”: “München”, “country”: “Germany”
phoneNumber	+49 89 99998458
emailAddress	doris-schneider@fischer-pflege-gmbh.example.org

Person: Doris Schneider

HTTP POST "/api/hs/office/persons" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY" \
  <<EOF
{
  "personType" : "NATURAL_PERSON",
  "familyName" : "Schneider",
  "givenName" : "Doris"
}
EOF
=> status: 201 CREATED f68078c5-aee8-4157-b704-33e1fcabf47e

Contact: Doris Schneider - Technik (P-90002)

HTTP POST "/api/hs/office/contacts" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY" \
  <<EOF
{
  "caption" : "Doris Schneider - Technik (P-90002)",
  "postalAddress" : {
    "street" : "Nelkenweg 142",
    "zipcode" : "80331",
    "city" : "München",
    "country" : "Germany"
  },
  "phoneNumbers" : {
    "office" : "+49 89 99998458"
  },
  "emailAddresses" : {
    "main" : "doris-schneider@fischer-pflege-gmbh.example.org"
  }
}
EOF
=> status: 201 CREATED 8184f087-d6f8-486f-b323-04ddb038265c

Create OPERATIONS: Doris Schneider - Technik (P-90002)

HTTP POST "/api/hs/office/relations" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY" \
  <<EOF
{
  "type" : "OPERATIONS",
  "anchor.uuid" : "6cb14931-a2c8-4bc4-ad64-46e89411f011", // Person: Fischer Pflege GmbH
  "holder.uuid" : "f68078c5-aee8-4157-b704-33e1fcabf47e", // Person: Doris Schneider
  "contact.uuid" : "8184f087-d6f8-486f-b323-04ddb038265c" // Contact: Doris Schneider - Technik (P-90002)
}
EOF
=> status: 201 CREATED e57e525f-08d9-4cc5-b282-62711514f59c

Verify the Relation Got Created

HTTP GET "/api/hs/office/relations/e57e525f-08d9-4cc5-b282-62711514f59c" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY"
=> status: 200 OK 
{
  "uuid" : "e57e525f-08d9-4cc5-b282-62711514f59c",
  "anchor" : {
    "uuid" : "6cb14931-a2c8-4bc4-ad64-46e89411f011", // Person: Fischer Pflege GmbH
    "personType" : "LEGAL_PERSON",
    "tradeName" : "Fischer Pflege GmbH",
    "salutation" : null,
    "title" : null,
    "givenName" : null,
    "familyName" : null
  },
  "holder" : {
    "uuid" : "f68078c5-aee8-4157-b704-33e1fcabf47e", // Person: Doris Schneider
    "personType" : "NATURAL_PERSON",
    "tradeName" : null,
    "salutation" : null,
    "title" : null,
    "givenName" : "Doris",
    "familyName" : "Schneider"
  },
  "type" : "OPERATIONS",
  "mark" : null,
  "contact" : {
    "uuid" : "8184f087-d6f8-486f-b323-04ddb038265c", // Contact: Doris Schneider - Technik (P-90002)
    "caption" : "Doris Schneider - Technik (P-90002)",
    "postalAddress" : {
      "zipcode" : "80331",
      "country" : "Germany",
      "city" : "München",
      "street" : "Nelkenweg 142"
    },
    "emailAddresses" : {
      "main" : "doris-schneider@fischer-pflege-gmbh.example.org"
    },
    "phoneNumbers" : {
      "office" : "+49 89 99998458"
    }
  }
}

UseCase Create Demo Debitor => Debitor: Fischer Pflege GmbH - Rechnungsstelle (D-9000200)

Properties

Given

name	value
partnerPersonName	Fischer Pflege GmbH
debitorNumberSuffix	00
billable	true
vatBusiness	false
defaultPrefix	aac
bankAccountHolder	Fischer Pflege GmbH (P-90002/0)
iban	DE35990100000247429672
bic	DEMSDEH0
billingContactCaption	Fischer Pflege GmbH - Rechnungsstelle (D-9000200)
billingContactEmailAddress	rechnung0@fischer-pflege-gmbh.example.org

BankAccount: Fischer Pflege GmbH (P-90002/0)

HTTP POST "/api/hs/office/bankaccounts" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY" \
  <<EOF
{
  "holder" : "Fischer Pflege GmbH (P-90002/0)",
  "iban" : "DE35990100000247429672",
  "bic" : "DEMSDEH0"
}
EOF
=> status: 201 CREATED 1360c7f7-1bc7-4e6a-af81-9fbb37dcac72

Contact: Fischer Pflege GmbH - Rechnungsstelle (D-9000200)

HTTP POST "/api/hs/office/contacts" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY" \
  <<EOF
{
  "caption" : "Fischer Pflege GmbH - Rechnungsstelle (D-9000200)",
  "emailAddresses" : {
    "main" : "rechnung0@fischer-pflege-gmbh.example.org"
  }
}
EOF
=> status: 201 CREATED 9aac35bb-bbde-4b98-9e95-c46f82998a91

Create Debitor: Fischer Pflege GmbH - Rechnungsstelle (D-9000200)

HTTP POST "/api/hs/office/debitors" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY" \
  <<EOF
{
  "debitorRel" : {
    "anchor.uuid" : "6cb14931-a2c8-4bc4-ad64-46e89411f011", // Person: Fischer Pflege GmbH
    "holder.uuid" : "6cb14931-a2c8-4bc4-ad64-46e89411f011", // Person: Fischer Pflege GmbH
    "contact.uuid" : "9aac35bb-bbde-4b98-9e95-c46f82998a91" // Contact: Fischer Pflege GmbH - Rechnungsstelle (D-9000200)
  },
  "debitorNumberSuffix" : "00",
  "billable" : true,
  "vatBusiness" : false,
  "vatReverseCharge" : false,
  "refundBankAccount.uuid" : "1360c7f7-1bc7-4e6a-af81-9fbb37dcac72", // BankAccount: Fischer Pflege GmbH (P-90002/0)
  "defaultPrefix" : "aac"
}
EOF
=> status: 201 CREATED 58ffec77-0635-4e7f-bdc5-2d1c11d4623b

Verify the Debitor Got Created

HTTP GET "/api/hs/office/debitors/58ffec77-0635-4e7f-bdc5-2d1c11d4623b" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY"
=> status: 200 OK 
{
  "uuid" : "58ffec77-0635-4e7f-bdc5-2d1c11d4623b",
  "debitorRel" : {
    "uuid" : "fa3fd321-1374-467f-9138-024c35185825",
    "anchor" : {
      "uuid" : "6cb14931-a2c8-4bc4-ad64-46e89411f011", // Person: Fischer Pflege GmbH
      "personType" : "LEGAL_PERSON",
      "tradeName" : "Fischer Pflege GmbH",
      "salutation" : null,
      "title" : null,
      "givenName" : null,
      "familyName" : null
    },
    "holder" : {
      "uuid" : "6cb14931-a2c8-4bc4-ad64-46e89411f011", // Person: Fischer Pflege GmbH
      "personType" : "LEGAL_PERSON",
      "tradeName" : "Fischer Pflege GmbH",
      "salutation" : null,
      "title" : null,
      "givenName" : null,
      "familyName" : null
    },
    "type" : "DEBITOR",
    "mark" : null,
    "contact" : {
      "uuid" : "9aac35bb-bbde-4b98-9e95-c46f82998a91", // Contact: Fischer Pflege GmbH - Rechnungsstelle (D-9000200)
      "caption" : "Fischer Pflege GmbH - Rechnungsstelle (D-9000200)",
      "postalAddress" : { },
      "emailAddresses" : {
        "main" : "rechnung0@fischer-pflege-gmbh.example.org"
      },
      "phoneNumbers" : { }
    }
  },
  "debitorNumber" : "D-9000200",
  "debitorNumberSuffix" : "00",
  "partner" : {
    "uuid" : "a6e52f79-7927-4f55-83b2-84e51615ea91",
    "partnerNumber" : "P-90002",
    "partnerRel" : {
      "uuid" : "506e77d7-e2c4-494d-a268-28b1c2d1f298",
      "anchor" : {
        "uuid" : "0ef98191-79d8-443e-89c1-1076e8f6df80", // Person: Hostsharing eG
        "personType" : "LEGAL_PERSON",
        "tradeName" : "Hostsharing eG",
        "salutation" : null,
        "title" : null,
        "givenName" : null,
        "familyName" : null
      },
      "holder" : {
        "uuid" : "6cb14931-a2c8-4bc4-ad64-46e89411f011", // Person: Fischer Pflege GmbH
        "personType" : "LEGAL_PERSON",
        "tradeName" : "Fischer Pflege GmbH",
        "salutation" : null,
        "title" : null,
        "givenName" : null,
        "familyName" : null
      },
      "type" : "PARTNER",
      "mark" : null,
      "contact" : {
        "uuid" : "43420671-aeed-4bd7-979a-6d8963e1dd8b", // Contact: Fischer Pflege GmbH - Hauptkontakt (P-90002)
        "caption" : "Fischer Pflege GmbH - Hauptkontakt (P-90002)",
        "postalAddress" : {
          "zipcode" : "28195",
          "country" : "Germany",
          "city" : "Bremen",
          "street" : "Bachstraße 553"
        },
        "emailAddresses" : {
          "main" : "info@fischer-pflege-gmbh.example.org"
        },
        "phoneNumbers" : {
          "office" : "+49 171 3920003"
        }
      }
    },
    "details" : {
      "uuid" : "611ca839-f8a0-459a-813e-c1c97f998d7f",
      "registrationOffice" : "Registergericht Bremen",
      "registrationNumber" : "310659",
      "birthName" : null,
      "birthPlace" : null,
      "birthday" : null,
      "dateOfDeath" : null
    }
  },
  "billable" : true,
  "vatId" : null,
  "vatCountryCode" : null,
  "vatBusiness" : false,
  "vatReverseCharge" : false,
  "refundBankAccount" : {
    "uuid" : "1360c7f7-1bc7-4e6a-af81-9fbb37dcac72", // BankAccount: Fischer Pflege GmbH (P-90002/0)
    "holder" : "Fischer Pflege GmbH (P-90002/0)",
    "iban" : "DE35990100000247429672",
    "bic" : "DEMSDEH0"
  },
  "defaultPrefix" : "aac"
}

UseCase Create Demo Sepa Mandate => SEPA-Mandat: D-9000200-aktuell

Properties

Given

name	value
debitorNumber	D-9000200
mandateReference	D-9000200-aktuell
bankAccountHolder	Fischer Pflege GmbH (P-90002/0/aktuell)
iban	DE76990100000045503743
bic	DEMSDEH0
agreement	2013-05-03
validFrom	2013-05-17

Debitor of D-9000200-aktuell

HTTP GET "/api/hs/office/debitors/D-9000200" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY"
=> status: 200 OK 
{
  "uuid" : "58ffec77-0635-4e7f-bdc5-2d1c11d4623b",
  "debitorRel" : {
    "uuid" : "fa3fd321-1374-467f-9138-024c35185825",
    "anchor" : {
      "uuid" : "6cb14931-a2c8-4bc4-ad64-46e89411f011", // Person: Fischer Pflege GmbH
      "personType" : "LEGAL_PERSON",
      "tradeName" : "Fischer Pflege GmbH",
      "salutation" : null,
      "title" : null,
      "givenName" : null,
      "familyName" : null
    },
    "holder" : {
      "uuid" : "6cb14931-a2c8-4bc4-ad64-46e89411f011", // Person: Fischer Pflege GmbH
      "personType" : "LEGAL_PERSON",
      "tradeName" : "Fischer Pflege GmbH",
      "salutation" : null,
      "title" : null,
      "givenName" : null,
      "familyName" : null
    },
    "type" : "DEBITOR",
    "mark" : null,
    "contact" : {
      "uuid" : "9aac35bb-bbde-4b98-9e95-c46f82998a91", // Contact: Fischer Pflege GmbH - Rechnungsstelle (D-9000200)
      "caption" : "Fischer Pflege GmbH - Rechnungsstelle (D-9000200)",
      "postalAddress" : { },
      "emailAddresses" : {
        "main" : "rechnung0@fischer-pflege-gmbh.example.org"
      },
      "phoneNumbers" : { }
    }
  },
  "debitorNumber" : "D-9000200",
  "debitorNumberSuffix" : "00",
  "partner" : {
    "uuid" : "a6e52f79-7927-4f55-83b2-84e51615ea91",
    "partnerNumber" : "P-90002",
    "partnerRel" : {
      "uuid" : "506e77d7-e2c4-494d-a268-28b1c2d1f298",
      "anchor" : {
        "uuid" : "0ef98191-79d8-443e-89c1-1076e8f6df80", // Person: Hostsharing eG
        "personType" : "LEGAL_PERSON",
        "tradeName" : "Hostsharing eG",
        "salutation" : null,
        "title" : null,
        "givenName" : null,
        "familyName" : null
      },
      "holder" : {
        "uuid" : "6cb14931-a2c8-4bc4-ad64-46e89411f011", // Person: Fischer Pflege GmbH
        "personType" : "LEGAL_PERSON",
        "tradeName" : "Fischer Pflege GmbH",
        "salutation" : null,
        "title" : null,
        "givenName" : null,
        "familyName" : null
      },
      "type" : "PARTNER",
      "mark" : null,
      "contact" : {
        "uuid" : "43420671-aeed-4bd7-979a-6d8963e1dd8b", // Contact: Fischer Pflege GmbH - Hauptkontakt (P-90002)
        "caption" : "Fischer Pflege GmbH - Hauptkontakt (P-90002)",
        "postalAddress" : {
          "zipcode" : "28195",
          "country" : "Germany",
          "city" : "Bremen",
          "street" : "Bachstraße 553"
        },
        "emailAddresses" : {
          "main" : "info@fischer-pflege-gmbh.example.org"
        },
        "phoneNumbers" : {
          "office" : "+49 171 3920003"
        }
      }
    },
    "details" : {
      "uuid" : "611ca839-f8a0-459a-813e-c1c97f998d7f",
      "registrationOffice" : "Registergericht Bremen",
      "registrationNumber" : "310659",
      "birthName" : null,
      "birthPlace" : null,
      "birthday" : null,
      "dateOfDeath" : null
    }
  },
  "billable" : true,
  "vatId" : null,
  "vatCountryCode" : null,
  "vatBusiness" : false,
  "vatReverseCharge" : false,
  "refundBankAccount" : {
    "uuid" : "1360c7f7-1bc7-4e6a-af81-9fbb37dcac72", // BankAccount: Fischer Pflege GmbH (P-90002/0)
    "holder" : "Fischer Pflege GmbH (P-90002/0)",
    "iban" : "DE35990100000247429672",
    "bic" : "DEMSDEH0"
  },
  "defaultPrefix" : "aac"
}

BankAccount: Fischer Pflege GmbH (P-90002/0/aktuell)

HTTP POST "/api/hs/office/bankaccounts" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY" \
  <<EOF
{
  "holder" : "Fischer Pflege GmbH (P-90002/0/aktuell)",
  "iban" : "DE76990100000045503743",
  "bic" : "DEMSDEH0"
}
EOF
=> status: 201 CREATED a0696f84-3c38-4aee-b477-22fb9ca26e92

Create SEPA-Mandat: D-9000200-aktuell

HTTP POST "/api/hs/office/sepamandates" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY" \
  <<EOF
{
  "debitor.uuid" : "58ffec77-0635-4e7f-bdc5-2d1c11d4623b", // Debitor of D-9000200-aktuell
  "bankAccount.uuid" : "a0696f84-3c38-4aee-b477-22fb9ca26e92", // BankAccount: Fischer Pflege GmbH (P-90002/0/aktuell)
  "reference" : "D-9000200-aktuell",
  "agreement" : "2013-05-03",
  "validFrom" : "2013-05-17"
}
EOF
=> status: 201 CREATED e660f76d-2459-4cbe-ac26-05fa1e7a3c42

Verify the SEPA-Mandate Got Created

HTTP GET "/api/hs/office/sepamandates/e660f76d-2459-4cbe-ac26-05fa1e7a3c42" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY"
=> status: 200 OK 
{
  "uuid" : "e660f76d-2459-4cbe-ac26-05fa1e7a3c42",
  "debitor" : {
    "uuid" : "58ffec77-0635-4e7f-bdc5-2d1c11d4623b", // Debitor of D-9000200-aktuell
    "debitorRel" : {
      "uuid" : "fa3fd321-1374-467f-9138-024c35185825",
      "anchor" : {
        "uuid" : "6cb14931-a2c8-4bc4-ad64-46e89411f011", // Person: Fischer Pflege GmbH
        "personType" : "LEGAL_PERSON",
        "tradeName" : "Fischer Pflege GmbH",
        "salutation" : null,
        "title" : null,
        "givenName" : null,
        "familyName" : null
      },
      "holder" : {
        "uuid" : "6cb14931-a2c8-4bc4-ad64-46e89411f011", // Person: Fischer Pflege GmbH
        "personType" : "LEGAL_PERSON",
        "tradeName" : "Fischer Pflege GmbH",
        "salutation" : null,
        "title" : null,
        "givenName" : null,
        "familyName" : null
      },
      "type" : "DEBITOR",
      "mark" : null,
      "contact" : {
        "uuid" : "9aac35bb-bbde-4b98-9e95-c46f82998a91", // Contact: Fischer Pflege GmbH - Rechnungsstelle (D-9000200)
        "caption" : "Fischer Pflege GmbH - Rechnungsstelle (D-9000200)",
        "postalAddress" : { },
        "emailAddresses" : {
          "main" : "rechnung0@fischer-pflege-gmbh.example.org"
        },
        "phoneNumbers" : { }
      }
    },
    "debitorNumber" : "D-9000200",
    "debitorNumberSuffix" : "00",
    "partner" : {
      "uuid" : "a6e52f79-7927-4f55-83b2-84e51615ea91",
      "partnerNumber" : "P-90002",
      "partnerRel" : {
        "uuid" : "506e77d7-e2c4-494d-a268-28b1c2d1f298",
        "anchor" : {
          "uuid" : "0ef98191-79d8-443e-89c1-1076e8f6df80", // Person: Hostsharing eG
          "personType" : "LEGAL_PERSON",
          "tradeName" : "Hostsharing eG",
          "salutation" : null,
          "title" : null,
          "givenName" : null,
          "familyName" : null
        },
        "holder" : {
          "uuid" : "6cb14931-a2c8-4bc4-ad64-46e89411f011", // Person: Fischer Pflege GmbH
          "personType" : "LEGAL_PERSON",
          "tradeName" : "Fischer Pflege GmbH",
          "salutation" : null,
          "title" : null,
          "givenName" : null,
          "familyName" : null
        },
        "type" : "PARTNER",
        "mark" : null,
        "contact" : {
          "uuid" : "43420671-aeed-4bd7-979a-6d8963e1dd8b", // Contact: Fischer Pflege GmbH - Hauptkontakt (P-90002)
          "caption" : "Fischer Pflege GmbH - Hauptkontakt (P-90002)",
          "postalAddress" : {
            "zipcode" : "28195",
            "country" : "Germany",
            "city" : "Bremen",
            "street" : "Bachstraße 553"
          },
          "emailAddresses" : {
            "main" : "info@fischer-pflege-gmbh.example.org"
          },
          "phoneNumbers" : {
            "office" : "+49 171 3920003"
          }
        }
      },
      "details" : {
        "uuid" : "611ca839-f8a0-459a-813e-c1c97f998d7f",
        "registrationOffice" : "Registergericht Bremen",
        "registrationNumber" : "310659",
        "birthName" : null,
        "birthPlace" : null,
        "birthday" : null,
        "dateOfDeath" : null
      }
    },
    "billable" : true,
    "vatId" : null,
    "vatCountryCode" : null,
    "vatBusiness" : false,
    "vatReverseCharge" : false,
    "refundBankAccount" : {
      "uuid" : "1360c7f7-1bc7-4e6a-af81-9fbb37dcac72", // BankAccount: Fischer Pflege GmbH (P-90002/0)
      "holder" : "Fischer Pflege GmbH (P-90002/0)",
      "iban" : "DE35990100000247429672",
      "bic" : "DEMSDEH0"
    },
    "defaultPrefix" : "aac"
  },
  "bankAccount" : {
    "uuid" : "a0696f84-3c38-4aee-b477-22fb9ca26e92", // BankAccount: Fischer Pflege GmbH (P-90002/0/aktuell)
    "holder" : "Fischer Pflege GmbH (P-90002/0/aktuell)",
    "iban" : "DE76990100000045503743",
    "bic" : "DEMSDEH0"
  },
  "reference" : "D-9000200-aktuell",
  "agreement" : "2013-05-03",
  "validFrom" : "2013-05-17",
  "validTo" : null
}

UseCase Create Demo Debitor => Debitor: Fischer Pflege GmbH - Rechnungsstelle (D-9000201)

Properties

Given

name	value
partnerPersonName	Fischer Pflege GmbH
debitorNumberSuffix	01
billable	true
vatBusiness	true
defaultPrefix	aad
bankAccountHolder	Fischer Pflege GmbH (P-90002/1)
iban	DE44990100000597317337
bic	DEMSDEH0
billingContactCaption	Fischer Pflege GmbH - Rechnungsstelle (D-9000201)
billingContactEmailAddress	rechnung1@fischer-pflege-gmbh.example.org

BankAccount: Fischer Pflege GmbH (P-90002/1)

HTTP POST "/api/hs/office/bankaccounts" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY" \
  <<EOF
{
  "holder" : "Fischer Pflege GmbH (P-90002/1)",
  "iban" : "DE44990100000597317337",
  "bic" : "DEMSDEH0"
}
EOF
=> status: 201 CREATED 2a257e4b-8a38-41d6-8021-9bb34f3e95d2

Contact: Fischer Pflege GmbH - Rechnungsstelle (D-9000201)

HTTP POST "/api/hs/office/contacts" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY" \
  <<EOF
{
  "caption" : "Fischer Pflege GmbH - Rechnungsstelle (D-9000201)",
  "emailAddresses" : {
    "main" : "rechnung1@fischer-pflege-gmbh.example.org"
  }
}
EOF
=> status: 201 CREATED 1ac6f72f-6809-44f0-8c9c-aa5307671c9f

Create Debitor: Fischer Pflege GmbH - Rechnungsstelle (D-9000201)

HTTP POST "/api/hs/office/debitors" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY" \
  <<EOF
{
  "debitorRel" : {
    "anchor.uuid" : "6cb14931-a2c8-4bc4-ad64-46e89411f011", // Person: Fischer Pflege GmbH
    "holder.uuid" : "6cb14931-a2c8-4bc4-ad64-46e89411f011", // Person: Fischer Pflege GmbH
    "contact.uuid" : "1ac6f72f-6809-44f0-8c9c-aa5307671c9f" // Contact: Fischer Pflege GmbH - Rechnungsstelle (D-9000201)
  },
  "debitorNumberSuffix" : "01",
  "billable" : true,
  "vatBusiness" : true,
  "vatReverseCharge" : false,
  "refundBankAccount.uuid" : "2a257e4b-8a38-41d6-8021-9bb34f3e95d2", // BankAccount: Fischer Pflege GmbH (P-90002/1)
  "defaultPrefix" : "aad"
}
EOF
=> status: 201 CREATED d87a9a40-bf72-4c49-8bf3-354e5ae2fd4d

Verify the Debitor Got Created

HTTP GET "/api/hs/office/debitors/d87a9a40-bf72-4c49-8bf3-354e5ae2fd4d" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY"
=> status: 200 OK 
{
  "uuid" : "d87a9a40-bf72-4c49-8bf3-354e5ae2fd4d",
  "debitorRel" : {
    "uuid" : "104a3dd9-f832-4125-bd1c-ad1e8847d3d3",
    "anchor" : {
      "uuid" : "6cb14931-a2c8-4bc4-ad64-46e89411f011", // Person: Fischer Pflege GmbH
      "personType" : "LEGAL_PERSON",
      "tradeName" : "Fischer Pflege GmbH",
      "salutation" : null,
      "title" : null,
      "givenName" : null,
      "familyName" : null
    },
    "holder" : {
      "uuid" : "6cb14931-a2c8-4bc4-ad64-46e89411f011", // Person: Fischer Pflege GmbH
      "personType" : "LEGAL_PERSON",
      "tradeName" : "Fischer Pflege GmbH",
      "salutation" : null,
      "title" : null,
      "givenName" : null,
      "familyName" : null
    },
    "type" : "DEBITOR",
    "mark" : null,
    "contact" : {
      "uuid" : "1ac6f72f-6809-44f0-8c9c-aa5307671c9f", // Contact: Fischer Pflege GmbH - Rechnungsstelle (D-9000201)
      "caption" : "Fischer Pflege GmbH - Rechnungsstelle (D-9000201)",
      "postalAddress" : { },
      "emailAddresses" : {
        "main" : "rechnung1@fischer-pflege-gmbh.example.org"
      },
      "phoneNumbers" : { }
    }
  },
  "debitorNumber" : "D-9000201",
  "debitorNumberSuffix" : "01",
  "partner" : {
    "uuid" : "a6e52f79-7927-4f55-83b2-84e51615ea91",
    "partnerNumber" : "P-90002",
    "partnerRel" : {
      "uuid" : "506e77d7-e2c4-494d-a268-28b1c2d1f298",
      "anchor" : {
        "uuid" : "0ef98191-79d8-443e-89c1-1076e8f6df80", // Person: Hostsharing eG
        "personType" : "LEGAL_PERSON",
        "tradeName" : "Hostsharing eG",
        "salutation" : null,
        "title" : null,
        "givenName" : null,
        "familyName" : null
      },
      "holder" : {
        "uuid" : "6cb14931-a2c8-4bc4-ad64-46e89411f011", // Person: Fischer Pflege GmbH
        "personType" : "LEGAL_PERSON",
        "tradeName" : "Fischer Pflege GmbH",
        "salutation" : null,
        "title" : null,
        "givenName" : null,
        "familyName" : null
      },
      "type" : "PARTNER",
      "mark" : null,
      "contact" : {
        "uuid" : "43420671-aeed-4bd7-979a-6d8963e1dd8b", // Contact: Fischer Pflege GmbH - Hauptkontakt (P-90002)
        "caption" : "Fischer Pflege GmbH - Hauptkontakt (P-90002)",
        "postalAddress" : {
          "zipcode" : "28195",
          "country" : "Germany",
          "city" : "Bremen",
          "street" : "Bachstraße 553"
        },
        "emailAddresses" : {
          "main" : "info@fischer-pflege-gmbh.example.org"
        },
        "phoneNumbers" : {
          "office" : "+49 171 3920003"
        }
      }
    },
    "details" : {
      "uuid" : "611ca839-f8a0-459a-813e-c1c97f998d7f",
      "registrationOffice" : "Registergericht Bremen",
      "registrationNumber" : "310659",
      "birthName" : null,
      "birthPlace" : null,
      "birthday" : null,
      "dateOfDeath" : null
    }
  },
  "billable" : true,
  "vatId" : null,
  "vatCountryCode" : null,
  "vatBusiness" : true,
  "vatReverseCharge" : false,
  "refundBankAccount" : {
    "uuid" : "2a257e4b-8a38-41d6-8021-9bb34f3e95d2", // BankAccount: Fischer Pflege GmbH (P-90002/1)
    "holder" : "Fischer Pflege GmbH (P-90002/1)",
    "iban" : "DE44990100000597317337",
    "bic" : "DEMSDEH0"
  },
  "defaultPrefix" : "aad"
}

UseCase Create Demo Sepa Mandate => SEPA-Mandat: D-9000201-aktuell

Properties

Given

name	value
debitorNumber	D-9000201
mandateReference	D-9000201-aktuell
bankAccountHolder	Fischer Pflege GmbH (P-90002/1/aktuell)
iban	DE41990100000935066832
bic	DEMSDEH0
agreement	2020-07-10
validFrom	2020-07-14

Debitor of D-9000201-aktuell

HTTP GET "/api/hs/office/debitors/D-9000201" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY"
=> status: 200 OK 
{
  "uuid" : "d87a9a40-bf72-4c49-8bf3-354e5ae2fd4d",
  "debitorRel" : {
    "uuid" : "104a3dd9-f832-4125-bd1c-ad1e8847d3d3",
    "anchor" : {
      "uuid" : "6cb14931-a2c8-4bc4-ad64-46e89411f011", // Person: Fischer Pflege GmbH
      "personType" : "LEGAL_PERSON",
      "tradeName" : "Fischer Pflege GmbH",
      "salutation" : null,
      "title" : null,
      "givenName" : null,
      "familyName" : null
    },
    "holder" : {
      "uuid" : "6cb14931-a2c8-4bc4-ad64-46e89411f011", // Person: Fischer Pflege GmbH
      "personType" : "LEGAL_PERSON",
      "tradeName" : "Fischer Pflege GmbH",
      "salutation" : null,
      "title" : null,
      "givenName" : null,
      "familyName" : null
    },
    "type" : "DEBITOR",
    "mark" : null,
    "contact" : {
      "uuid" : "1ac6f72f-6809-44f0-8c9c-aa5307671c9f", // Contact: Fischer Pflege GmbH - Rechnungsstelle (D-9000201)
      "caption" : "Fischer Pflege GmbH - Rechnungsstelle (D-9000201)",
      "postalAddress" : { },
      "emailAddresses" : {
        "main" : "rechnung1@fischer-pflege-gmbh.example.org"
      },
      "phoneNumbers" : { }
    }
  },
  "debitorNumber" : "D-9000201",
  "debitorNumberSuffix" : "01",
  "partner" : {
    "uuid" : "a6e52f79-7927-4f55-83b2-84e51615ea91",
    "partnerNumber" : "P-90002",
    "partnerRel" : {
      "uuid" : "506e77d7-e2c4-494d-a268-28b1c2d1f298",
      "anchor" : {
        "uuid" : "0ef98191-79d8-443e-89c1-1076e8f6df80", // Person: Hostsharing eG
        "personType" : "LEGAL_PERSON",
        "tradeName" : "Hostsharing eG",
        "salutation" : null,
        "title" : null,
        "givenName" : null,
        "familyName" : null
      },
      "holder" : {
        "uuid" : "6cb14931-a2c8-4bc4-ad64-46e89411f011", // Person: Fischer Pflege GmbH
        "personType" : "LEGAL_PERSON",
        "tradeName" : "Fischer Pflege GmbH",
        "salutation" : null,
        "title" : null,
        "givenName" : null,
        "familyName" : null
      },
      "type" : "PARTNER",
      "mark" : null,
      "contact" : {
        "uuid" : "43420671-aeed-4bd7-979a-6d8963e1dd8b", // Contact: Fischer Pflege GmbH - Hauptkontakt (P-90002)
        "caption" : "Fischer Pflege GmbH - Hauptkontakt (P-90002)",
        "postalAddress" : {
          "zipcode" : "28195",
          "country" : "Germany",
          "city" : "Bremen",
          "street" : "Bachstraße 553"
        },
        "emailAddresses" : {
          "main" : "info@fischer-pflege-gmbh.example.org"
        },
        "phoneNumbers" : {
          "office" : "+49 171 3920003"
        }
      }
    },
    "details" : {
      "uuid" : "611ca839-f8a0-459a-813e-c1c97f998d7f",
      "registrationOffice" : "Registergericht Bremen",
      "registrationNumber" : "310659",
      "birthName" : null,
      "birthPlace" : null,
      "birthday" : null,
      "dateOfDeath" : null
    }
  },
  "billable" : true,
  "vatId" : null,
  "vatCountryCode" : null,
  "vatBusiness" : true,
  "vatReverseCharge" : false,
  "refundBankAccount" : {
    "uuid" : "2a257e4b-8a38-41d6-8021-9bb34f3e95d2", // BankAccount: Fischer Pflege GmbH (P-90002/1)
    "holder" : "Fischer Pflege GmbH (P-90002/1)",
    "iban" : "DE44990100000597317337",
    "bic" : "DEMSDEH0"
  },
  "defaultPrefix" : "aad"
}

BankAccount: Fischer Pflege GmbH (P-90002/1/aktuell)

HTTP POST "/api/hs/office/bankaccounts" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY" \
  <<EOF
{
  "holder" : "Fischer Pflege GmbH (P-90002/1/aktuell)",
  "iban" : "DE41990100000935066832",
  "bic" : "DEMSDEH0"
}
EOF
=> status: 201 CREATED b0523b7d-deef-4cfa-8779-177cff2c716d

Create SEPA-Mandat: D-9000201-aktuell

HTTP POST "/api/hs/office/sepamandates" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY" \
  <<EOF
{
  "debitor.uuid" : "d87a9a40-bf72-4c49-8bf3-354e5ae2fd4d", // Debitor of D-9000201-aktuell
  "bankAccount.uuid" : "b0523b7d-deef-4cfa-8779-177cff2c716d", // BankAccount: Fischer Pflege GmbH (P-90002/1/aktuell)
  "reference" : "D-9000201-aktuell",
  "agreement" : "2020-07-10",
  "validFrom" : "2020-07-14"
}
EOF
=> status: 201 CREATED 470c3845-ff24-4f7a-96fa-86f5e546edf5

Verify the SEPA-Mandate Got Created

HTTP GET "/api/hs/office/sepamandates/470c3845-ff24-4f7a-96fa-86f5e546edf5" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY"
=> status: 200 OK 
{
  "uuid" : "470c3845-ff24-4f7a-96fa-86f5e546edf5",
  "debitor" : {
    "uuid" : "d87a9a40-bf72-4c49-8bf3-354e5ae2fd4d", // Debitor of D-9000201-aktuell
    "debitorRel" : {
      "uuid" : "104a3dd9-f832-4125-bd1c-ad1e8847d3d3",
      "anchor" : {
        "uuid" : "6cb14931-a2c8-4bc4-ad64-46e89411f011", // Person: Fischer Pflege GmbH
        "personType" : "LEGAL_PERSON",
        "tradeName" : "Fischer Pflege GmbH",
        "salutation" : null,
        "title" : null,
        "givenName" : null,
        "familyName" : null
      },
      "holder" : {
        "uuid" : "6cb14931-a2c8-4bc4-ad64-46e89411f011", // Person: Fischer Pflege GmbH
        "personType" : "LEGAL_PERSON",
        "tradeName" : "Fischer Pflege GmbH",
        "salutation" : null,
        "title" : null,
        "givenName" : null,
        "familyName" : null
      },
      "type" : "DEBITOR",
      "mark" : null,
      "contact" : {
        "uuid" : "1ac6f72f-6809-44f0-8c9c-aa5307671c9f", // Contact: Fischer Pflege GmbH - Rechnungsstelle (D-9000201)
        "caption" : "Fischer Pflege GmbH - Rechnungsstelle (D-9000201)",
        "postalAddress" : { },
        "emailAddresses" : {
          "main" : "rechnung1@fischer-pflege-gmbh.example.org"
        },
        "phoneNumbers" : { }
      }
    },
    "debitorNumber" : "D-9000201",
    "debitorNumberSuffix" : "01",
    "partner" : {
      "uuid" : "a6e52f79-7927-4f55-83b2-84e51615ea91",
      "partnerNumber" : "P-90002",
      "partnerRel" : {
        "uuid" : "506e77d7-e2c4-494d-a268-28b1c2d1f298",
        "anchor" : {
          "uuid" : "0ef98191-79d8-443e-89c1-1076e8f6df80", // Person: Hostsharing eG
          "personType" : "LEGAL_PERSON",
          "tradeName" : "Hostsharing eG",
          "salutation" : null,
          "title" : null,
          "givenName" : null,
          "familyName" : null
        },
        "holder" : {
          "uuid" : "6cb14931-a2c8-4bc4-ad64-46e89411f011", // Person: Fischer Pflege GmbH
          "personType" : "LEGAL_PERSON",
          "tradeName" : "Fischer Pflege GmbH",
          "salutation" : null,
          "title" : null,
          "givenName" : null,
          "familyName" : null
        },
        "type" : "PARTNER",
        "mark" : null,
        "contact" : {
          "uuid" : "43420671-aeed-4bd7-979a-6d8963e1dd8b", // Contact: Fischer Pflege GmbH - Hauptkontakt (P-90002)
          "caption" : "Fischer Pflege GmbH - Hauptkontakt (P-90002)",
          "postalAddress" : {
            "zipcode" : "28195",
            "country" : "Germany",
            "city" : "Bremen",
            "street" : "Bachstraße 553"
          },
          "emailAddresses" : {
            "main" : "info@fischer-pflege-gmbh.example.org"
          },
          "phoneNumbers" : {
            "office" : "+49 171 3920003"
          }
        }
      },
      "details" : {
        "uuid" : "611ca839-f8a0-459a-813e-c1c97f998d7f",
        "registrationOffice" : "Registergericht Bremen",
        "registrationNumber" : "310659",
        "birthName" : null,
        "birthPlace" : null,
        "birthday" : null,
        "dateOfDeath" : null
      }
    },
    "billable" : true,
    "vatId" : null,
    "vatCountryCode" : null,
    "vatBusiness" : true,
    "vatReverseCharge" : false,
    "refundBankAccount" : {
      "uuid" : "2a257e4b-8a38-41d6-8021-9bb34f3e95d2", // BankAccount: Fischer Pflege GmbH (P-90002/1)
      "holder" : "Fischer Pflege GmbH (P-90002/1)",
      "iban" : "DE44990100000597317337",
      "bic" : "DEMSDEH0"
    },
    "defaultPrefix" : "aad"
  },
  "bankAccount" : {
    "uuid" : "b0523b7d-deef-4cfa-8779-177cff2c716d", // BankAccount: Fischer Pflege GmbH (P-90002/1/aktuell)
    "holder" : "Fischer Pflege GmbH (P-90002/1/aktuell)",
    "iban" : "DE41990100000935066832",
    "bic" : "DEMSDEH0"
  },
  "reference" : "D-9000201-aktuell",
  "agreement" : "2020-07-10",
  "validFrom" : "2020-07-14",
  "validTo" : null
}

UseCase Create Membership => Membership: Fischer Pflege GmbH

Properties

Given

name	value
partnerNumber	P-90002
validFrom	2010-07-10
membershipFeeBillable	true

Partner: P-90002

HTTP GET "/api/hs/office/partners/P-90002" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY"
=> status: 200 OK 
{
  "uuid" : "a6e52f79-7927-4f55-83b2-84e51615ea91",
  "partnerNumber" : "P-90002",
  "partnerRel" : {
    "uuid" : "506e77d7-e2c4-494d-a268-28b1c2d1f298",
    "anchor" : {
      "uuid" : "0ef98191-79d8-443e-89c1-1076e8f6df80", // Person: Hostsharing eG
      "personType" : "LEGAL_PERSON",
      "tradeName" : "Hostsharing eG",
      "salutation" : null,
      "title" : null,
      "givenName" : null,
      "familyName" : null
    },
    "holder" : {
      "uuid" : "6cb14931-a2c8-4bc4-ad64-46e89411f011", // Person: Fischer Pflege GmbH
      "personType" : "LEGAL_PERSON",
      "tradeName" : "Fischer Pflege GmbH",
      "salutation" : null,
      "title" : null,
      "givenName" : null,
      "familyName" : null
    },
    "type" : "PARTNER",
    "mark" : null,
    "contact" : {
      "uuid" : "43420671-aeed-4bd7-979a-6d8963e1dd8b", // Contact: Fischer Pflege GmbH - Hauptkontakt (P-90002)
      "caption" : "Fischer Pflege GmbH - Hauptkontakt (P-90002)",
      "postalAddress" : {
        "zipcode" : "28195",
        "country" : "Germany",
        "city" : "Bremen",
        "street" : "Bachstraße 553"
      },
      "emailAddresses" : {
        "main" : "info@fischer-pflege-gmbh.example.org"
      },
      "phoneNumbers" : {
        "office" : "+49 171 3920003"
      }
    }
  },
  "details" : {
    "uuid" : "611ca839-f8a0-459a-813e-c1c97f998d7f",
    "registrationOffice" : "Registergericht Bremen",
    "registrationNumber" : "310659",
    "birthName" : null,
    "birthPlace" : null,
    "birthday" : null,
    "dateOfDeath" : null
  }
}

The partner-number identifies the partner; a lookup by name could not, because a natural person carries its name in two columns and any name can be the prefix of a longer one.

Create Membership: Fischer Pflege GmbH

HTTP POST "/api/hs/office/memberships" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY" \
  <<EOF
{
  "partner.uuid" : "a6e52f79-7927-4f55-83b2-84e51615ea91", // Partner: P-90002
  "memberNumberSuffix" : "00",
  "status" : "ACTIVE",
  "validFrom" : "2010-07-10",
  "membershipFeeBillable" : true
}
EOF
=> status: 201 CREATED 89d08117-08c1-49ca-bd9e-931aca5df418

Verify That the Membership Got Created

HTTP GET "/api/hs/office/memberships/89d08117-08c1-49ca-bd9e-931aca5df418" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY"
=> status: 200 OK 
{
  "uuid" : "89d08117-08c1-49ca-bd9e-931aca5df418",
  "partner" : {
    "uuid" : "a6e52f79-7927-4f55-83b2-84e51615ea91", // Partner: P-90002
    "partnerNumber" : "P-90002",
    "partnerRel" : {
      "uuid" : "506e77d7-e2c4-494d-a268-28b1c2d1f298",
      "anchor" : {
        "uuid" : "0ef98191-79d8-443e-89c1-1076e8f6df80", // Person: Hostsharing eG
        "personType" : "LEGAL_PERSON",
        "tradeName" : "Hostsharing eG",
        "salutation" : null,
        "title" : null,
        "givenName" : null,
        "familyName" : null
      },
      "holder" : {
        "uuid" : "6cb14931-a2c8-4bc4-ad64-46e89411f011", // Person: Fischer Pflege GmbH
        "personType" : "LEGAL_PERSON",
        "tradeName" : "Fischer Pflege GmbH",
        "salutation" : null,
        "title" : null,
        "givenName" : null,
        "familyName" : null
      },
      "type" : "PARTNER",
      "mark" : null,
      "contact" : {
        "uuid" : "43420671-aeed-4bd7-979a-6d8963e1dd8b", // Contact: Fischer Pflege GmbH - Hauptkontakt (P-90002)
        "caption" : "Fischer Pflege GmbH - Hauptkontakt (P-90002)",
        "postalAddress" : {
          "zipcode" : "28195",
          "country" : "Germany",
          "city" : "Bremen",
          "street" : "Bachstraße 553"
        },
        "emailAddresses" : {
          "main" : "info@fischer-pflege-gmbh.example.org"
        },
        "phoneNumbers" : {
          "office" : "+49 171 3920003"
        }
      }
    },
    "details" : {
      "uuid" : "611ca839-f8a0-459a-813e-c1c97f998d7f",
      "registrationOffice" : "Registergericht Bremen",
      "registrationNumber" : "310659",
      "birthName" : null,
      "birthPlace" : null,
      "birthday" : null,
      "dateOfDeath" : null
    }
  },
  "mainDebitor" : null,
  "memberNumber" : "M-9000200",
  "memberNumberSuffix" : "00",
  "validFrom" : "2010-07-10",
  "validTo" : null,
  "status" : "ACTIVE",
  "membershipFeeBillable" : true
}

Properties

Given

name	value
transactionType	SUBSCRIPTION
memberNumber	M-9000200
reference	sign 2010-07-10
shareCount	35
comment	initial shares on joining
transactionDate	2010-07-10

Find membershipUuid

HTTP GET "/api/hs/office/memberships/M-9000200" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY"
=> status: 200 OK 
{
  "uuid" : "89d08117-08c1-49ca-bd9e-931aca5df418",
  "partner" : {
    "uuid" : "a6e52f79-7927-4f55-83b2-84e51615ea91", // Partner: P-90002
    "partnerNumber" : "P-90002",
    "partnerRel" : {
      "uuid" : "506e77d7-e2c4-494d-a268-28b1c2d1f298",
      "anchor" : {
        "uuid" : "0ef98191-79d8-443e-89c1-1076e8f6df80", // Person: Hostsharing eG
        "personType" : "LEGAL_PERSON",
        "tradeName" : "Hostsharing eG",
        "salutation" : null,
        "title" : null,
        "givenName" : null,
        "familyName" : null
      },
      "holder" : {
        "uuid" : "6cb14931-a2c8-4bc4-ad64-46e89411f011", // Person: Fischer Pflege GmbH
        "personType" : "LEGAL_PERSON",
        "tradeName" : "Fischer Pflege GmbH",
        "salutation" : null,
        "title" : null,
        "givenName" : null,
        "familyName" : null
      },
      "type" : "PARTNER",
      "mark" : null,
      "contact" : {
        "uuid" : "43420671-aeed-4bd7-979a-6d8963e1dd8b", // Contact: Fischer Pflege GmbH - Hauptkontakt (P-90002)
        "caption" : "Fischer Pflege GmbH - Hauptkontakt (P-90002)",
        "postalAddress" : {
          "zipcode" : "28195",
          "country" : "Germany",
          "city" : "Bremen",
          "street" : "Bachstraße 553"
        },
        "emailAddresses" : {
          "main" : "info@fischer-pflege-gmbh.example.org"
        },
        "phoneNumbers" : {
          "office" : "+49 171 3920003"
        }
      }
    },
    "details" : {
      "uuid" : "611ca839-f8a0-459a-813e-c1c97f998d7f",
      "registrationOffice" : "Registergericht Bremen",
      "registrationNumber" : "310659",
      "birthName" : null,
      "birthPlace" : null,
      "birthday" : null,
      "dateOfDeath" : null
    }
  },
  "mainDebitor" : null,
  "memberNumber" : "M-9000200",
  "memberNumberSuffix" : "00",
  "validFrom" : "2010-07-10",
  "validTo" : null,
  "status" : "ACTIVE",
  "membershipFeeBillable" : true
}

Create the Coop-Shares-SUBSCRIPTION Transaction

HTTP POST "/api/hs/office/coopsharestransactions" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY" \
  <<EOF
{
  "membership.uuid" : "89d08117-08c1-49ca-bd9e-931aca5df418", // membershipUuid
  "transactionType" : "SUBSCRIPTION",
  "reference" : "sign 2010-07-10",
  "shareCount" : 35,
  "comment" : "initial shares on joining",
  "valueDate" : "2010-07-10"
}
EOF
=> status: 201 CREATED e81f6667-3016-4544-ba9d-8c539b31ac5e

Verify Coop-Shares SUBSCRIPTION-Transaction

HTTP GET "/api/hs/office/coopsharestransactions/e81f6667-3016-4544-ba9d-8c539b31ac5e" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY"
=> status: 200 OK 
{
  "uuid" : "e81f6667-3016-4544-ba9d-8c539b31ac5e",
  "membership.uuid" : "89d08117-08c1-49ca-bd9e-931aca5df418", // membershipUuid
  "transactionType" : "SUBSCRIPTION",
  "shareCount" : 35,
  "valueDate" : "2010-07-10",
  "reference" : "sign 2010-07-10",
  "comment" : "initial shares on joining",
  "revertedShareTx" : null,
  "reversalShareTx" : null
}

Properties

Given

name	value
transactionType	DEPOSIT
memberNumber	M-9000200
reference	sign 2010-07-10
assetValue	2240
comment	deposit for initial shares
transactionDate	2010-07-11

Find membershipUuid

HTTP GET "/api/hs/office/memberships/M-9000200" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY"
=> status: 200 OK 
{
  "uuid" : "89d08117-08c1-49ca-bd9e-931aca5df418", // membershipUuid
  "partner" : {
    "uuid" : "a6e52f79-7927-4f55-83b2-84e51615ea91", // Partner: P-90002
    "partnerNumber" : "P-90002",
    "partnerRel" : {
      "uuid" : "506e77d7-e2c4-494d-a268-28b1c2d1f298",
      "anchor" : {
        "uuid" : "0ef98191-79d8-443e-89c1-1076e8f6df80", // Person: Hostsharing eG
        "personType" : "LEGAL_PERSON",
        "tradeName" : "Hostsharing eG",
        "salutation" : null,
        "title" : null,
        "givenName" : null,
        "familyName" : null
      },
      "holder" : {
        "uuid" : "6cb14931-a2c8-4bc4-ad64-46e89411f011", // Person: Fischer Pflege GmbH
        "personType" : "LEGAL_PERSON",
        "tradeName" : "Fischer Pflege GmbH",
        "salutation" : null,
        "title" : null,
        "givenName" : null,
        "familyName" : null
      },
      "type" : "PARTNER",
      "mark" : null,
      "contact" : {
        "uuid" : "43420671-aeed-4bd7-979a-6d8963e1dd8b", // Contact: Fischer Pflege GmbH - Hauptkontakt (P-90002)
        "caption" : "Fischer Pflege GmbH - Hauptkontakt (P-90002)",
        "postalAddress" : {
          "zipcode" : "28195",
          "country" : "Germany",
          "city" : "Bremen",
          "street" : "Bachstraße 553"
        },
        "emailAddresses" : {
          "main" : "info@fischer-pflege-gmbh.example.org"
        },
        "phoneNumbers" : {
          "office" : "+49 171 3920003"
        }
      }
    },
    "details" : {
      "uuid" : "611ca839-f8a0-459a-813e-c1c97f998d7f",
      "registrationOffice" : "Registergericht Bremen",
      "registrationNumber" : "310659",
      "birthName" : null,
      "birthPlace" : null,
      "birthday" : null,
      "dateOfDeath" : null
    }
  },
  "mainDebitor" : null,
  "memberNumber" : "M-9000200",
  "memberNumberSuffix" : "00",
  "validFrom" : "2010-07-10",
  "validTo" : null,
  "status" : "ACTIVE",
  "membershipFeeBillable" : true
}

Create the Coop-Assets-DEPOSIT Transaction

HTTP POST "/api/hs/office/coopassetstransactions" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY" \
  <<EOF
{
  "membership.uuid" : "89d08117-08c1-49ca-bd9e-931aca5df418", // membershipUuid
  "transactionType" : "DEPOSIT",
  "reference" : "sign 2010-07-10",
  "assetValue" : 2240,
  "comment" : "deposit for initial shares",
  "valueDate" : "2010-07-11"
}
EOF
=> status: 201 CREATED ebfa7750-9e8f-48b3-9784-83157742cf69

Verify Coop-Assets DEPOSIT-Transaction

HTTP GET "/api/hs/office/coopassetstransactions/ebfa7750-9e8f-48b3-9784-83157742cf69" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY"
=> status: 200 OK 
{
  "uuid" : "ebfa7750-9e8f-48b3-9784-83157742cf69",
  "membership.uuid" : "89d08117-08c1-49ca-bd9e-931aca5df418", // membershipUuid
  "membership.memberNumber" : "M-9000200",
  "transactionType" : "DEPOSIT",
  "assetValue" : 2.24E+3,
  "valueDate" : "2010-07-11",
  "reference" : "sign 2010-07-10",
  "comment" : "deposit for initial shares",
  "adoptionAssetTx" : null,
  "transferAssetTx" : null,
  "revertedAssetTx" : null,
  "reversalAssetTx" : null
}

Contact: Daniel Fischer - private Mailinglisten-Adresse

HTTP POST "/api/hs/office/contacts" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY" \
  <<EOF
{
  "caption" : "Daniel Fischer - private Mailinglisten-Adresse",
  "postalAddress" : {
    "street" : "Erlenkamp 678",
    "zipcode" : "70173",
    "city" : "Stuttgart",
    "country" : "Germany"
  },
  "phoneNumbers" : {
    "main" : "+49 176 04069030"
  },
  "emailAddresses" : {
    "main" : "daniel-fischer@example.net"
  }
}
EOF
=> status: 201 CREATED 2aca338d-0a93-45bc-abdd-78c432b2d8df

UseCase Add Demo Subscription => SUBSCRIBER members-announce: Daniel Fischer (P-90002)

Properties

Given

name	value
partnerPersonName	Fischer Pflege GmbH
mailingList	members-announce
holderGivenName	Daniel
holderFamilyName	Fischer
contactCaption	Daniel Fischer - private Mailinglisten-Adresse

Create SUBSCRIBER members-announce: Daniel Fischer (P-90002)

HTTP POST "/api/hs/office/relations" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY" \
  <<EOF
{
  "type" : "SUBSCRIBER",
  "mark" : "members-announce",
  "anchor.uuid" : "6cb14931-a2c8-4bc4-ad64-46e89411f011", // Person: Fischer Pflege GmbH
  "holder.uuid" : "bcf825af-0787-4e8e-b901-71397c604f48", // Person: Daniel Fischer
  "contact.uuid" : "2aca338d-0a93-45bc-abdd-78c432b2d8df" // Contact: Daniel Fischer - private Mailinglisten-Adresse
}
EOF
=> status: 201 CREATED a41577ea-1b58-4aa5-a703-1b2e3550b55f

Verify the Subscription Got Created

HTTP GET "/api/hs/office/relations/a41577ea-1b58-4aa5-a703-1b2e3550b55f" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY"
=> status: 200 OK 
{
  "uuid" : "a41577ea-1b58-4aa5-a703-1b2e3550b55f",
  "anchor" : {
    "uuid" : "6cb14931-a2c8-4bc4-ad64-46e89411f011", // Person: Fischer Pflege GmbH
    "personType" : "LEGAL_PERSON",
    "tradeName" : "Fischer Pflege GmbH",
    "salutation" : null,
    "title" : null,
    "givenName" : null,
    "familyName" : null
  },
  "holder" : {
    "uuid" : "bcf825af-0787-4e8e-b901-71397c604f48", // Person: Daniel Fischer
    "personType" : "NATURAL_PERSON",
    "tradeName" : null,
    "salutation" : null,
    "title" : null,
    "givenName" : "Daniel",
    "familyName" : "Fischer"
  },
  "type" : "SUBSCRIBER",
  "mark" : "members-announce",
  "contact" : {
    "uuid" : "2aca338d-0a93-45bc-abdd-78c432b2d8df", // Contact: Daniel Fischer - private Mailinglisten-Adresse
    "caption" : "Daniel Fischer - private Mailinglisten-Adresse",
    "postalAddress" : {
      "zipcode" : "70173",
      "country" : "Germany",
      "city" : "Stuttgart",
      "street" : "Erlenkamp 678"
    },
    "emailAddresses" : {
      "main" : "daniel-fischer@example.net"
    },
    "phoneNumbers" : {
      "main" : "+49 176 04069030"
    }
  }
}

UseCase Add Demo Subscription => SUBSCRIBER customers-announce: Daniel Fischer (P-90002)

Properties

Given

name	value
partnerPersonName	Fischer Pflege GmbH
mailingList	customers-announce
holderGivenName	Daniel
holderFamilyName	Fischer
contactCaption	Daniel Fischer - private Mailinglisten-Adresse

Create SUBSCRIBER customers-announce: Daniel Fischer (P-90002)

HTTP POST "/api/hs/office/relations" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY" \
  <<EOF
{
  "type" : "SUBSCRIBER",
  "mark" : "customers-announce",
  "anchor.uuid" : "6cb14931-a2c8-4bc4-ad64-46e89411f011", // Person: Fischer Pflege GmbH
  "holder.uuid" : "bcf825af-0787-4e8e-b901-71397c604f48", // Person: Daniel Fischer
  "contact.uuid" : "2aca338d-0a93-45bc-abdd-78c432b2d8df" // Contact: Daniel Fischer - private Mailinglisten-Adresse
}
EOF
=> status: 201 CREATED 7d614fce-0b8a-4055-82bb-14ca1b43040a

Verify the Subscription Got Created

HTTP GET "/api/hs/office/relations/7d614fce-0b8a-4055-82bb-14ca1b43040a" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY"
=> status: 200 OK 
{
  "uuid" : "7d614fce-0b8a-4055-82bb-14ca1b43040a",
  "anchor" : {
    "uuid" : "6cb14931-a2c8-4bc4-ad64-46e89411f011", // Person: Fischer Pflege GmbH
    "personType" : "LEGAL_PERSON",
    "tradeName" : "Fischer Pflege GmbH",
    "salutation" : null,
    "title" : null,
    "givenName" : null,
    "familyName" : null
  },
  "holder" : {
    "uuid" : "bcf825af-0787-4e8e-b901-71397c604f48", // Person: Daniel Fischer
    "personType" : "NATURAL_PERSON",
    "tradeName" : null,
    "salutation" : null,
    "title" : null,
    "givenName" : "Daniel",
    "familyName" : "Fischer"
  },
  "type" : "SUBSCRIBER",
  "mark" : "customers-announce",
  "contact" : {
    "uuid" : "2aca338d-0a93-45bc-abdd-78c432b2d8df", // Contact: Daniel Fischer - private Mailinglisten-Adresse
    "caption" : "Daniel Fischer - private Mailinglisten-Adresse",
    "postalAddress" : {
      "zipcode" : "70173",
      "country" : "Germany",
      "city" : "Stuttgart",
      "street" : "Erlenkamp 678"
    },
    "emailAddresses" : {
      "main" : "daniel-fischer@example.net"
    },
    "phoneNumbers" : {
      "main" : "+49 176 04069030"
    }
  }
}

UseCase Create Partner => Partner: P-90003 - Fuchs GmbH

Properties

Given

name	value
partnerNumber	P-90003
personType	LEGAL_PERSON
contactCaption	Fuchs GmbH - Hauptkontakt (P-90003)
postalAddress	“name”: “Rechnungsstelle”, “street”: “Bachstraße 290”, “zipcode”: “80331”, “city”: “München”, “country”: “Germany”
officePhoneNumber	+49 89 99998009
emailAddress	info@fuchs-gmbh.example.org
tradeName	Fuchs GmbH
registrationOffice	Registergericht München
registrationNumber	322619

Person: Hostsharing eG

HTTP GET "/api/hs/office/persons?name=Hostsharing+eG" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY"
=> status: 200 OK 
[ {
  "uuid" : "0ef98191-79d8-443e-89c1-1076e8f6df80", // Person: Hostsharing eG
  "personType" : "LEGAL_PERSON",
  "tradeName" : "Hostsharing eG",
  "salutation" : null,
  "title" : null,
  "givenName" : null,
  "familyName" : null
} ]

Even in production data we expect this query to return just a single result.

Person: Fuchs GmbH

HTTP POST "/api/hs/office/persons" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY" \
  <<EOF
{
  "personType" : "LEGAL_PERSON",
  "tradeName" : "Fuchs GmbH"
}
EOF
=> status: 201 CREATED d689405e-aea5-457a-a577-09a0b1887151

Contact: Fuchs GmbH - Hauptkontakt (P-90003)

HTTP POST "/api/hs/office/contacts" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY" \
  <<EOF
{
  "caption" : "Fuchs GmbH - Hauptkontakt (P-90003)",
  "postalAddress" : {
    "name" : "Rechnungsstelle",
    "street" : "Bachstraße 290",
    "zipcode" : "80331",
    "city" : "München",
    "country" : "Germany"
  },
  "phoneNumbers" : {
    "office" : "+49 89 99998009"
  },
  "emailAddresses" : {
    "main" : "info@fuchs-gmbh.example.org"
  }
}
EOF
=> status: 201 CREATED 214d3c9b-ab48-4514-ba5a-e0c20e5c5c7e

Create Partner: P-90003 - Fuchs GmbH

HTTP POST "/api/hs/office/partners" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY" \
  <<EOF
{
  "partnerNumber" : "P-90003",
  "partnerRel" : {
    "anchor.uuid" : "0ef98191-79d8-443e-89c1-1076e8f6df80", // Person: Hostsharing eG
    "holder.uuid" : "d689405e-aea5-457a-a577-09a0b1887151", // Person: Fuchs GmbH
    "contact.uuid" : "214d3c9b-ab48-4514-ba5a-e0c20e5c5c7e" // Contact: Fuchs GmbH - Hauptkontakt (P-90003)
  },
  "details" : {
    "registrationOffice" : "Registergericht München",
    "registrationNumber" : "322619"
  }
}
EOF
=> status: 201 CREATED 7a476b6b-bc74-4960-858c-598f281f6aae

Verify the New Partner Relation

HTTP GET "/api/hs/office/relations?relationType=PARTNER&contactData=Fuchs+GmbH+-+Hauptkontakt+%28P-90003%29" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY"
=> status: 200 OK 
[ {
  "uuid" : "e4560db0-e29d-4a19-b99c-fa0fbc1195e6",
  "anchor" : {
    "uuid" : "0ef98191-79d8-443e-89c1-1076e8f6df80", // Person: Hostsharing eG
    "personType" : "LEGAL_PERSON",
    "tradeName" : "Hostsharing eG",
    "salutation" : null,
    "title" : null,
    "givenName" : null,
    "familyName" : null
  },
  "holder" : {
    "uuid" : "d689405e-aea5-457a-a577-09a0b1887151", // Person: Fuchs GmbH
    "personType" : "LEGAL_PERSON",
    "tradeName" : "Fuchs GmbH",
    "salutation" : null,
    "title" : null,
    "givenName" : null,
    "familyName" : null
  },
  "type" : "PARTNER",
  "mark" : null,
  "contact" : {
    "uuid" : "214d3c9b-ab48-4514-ba5a-e0c20e5c5c7e", // Contact: Fuchs GmbH - Hauptkontakt (P-90003)
    "caption" : "Fuchs GmbH - Hauptkontakt (P-90003)",
    "postalAddress" : {
      "zipcode" : "80331",
      "country" : "Germany",
      "city" : "München",
      "street" : "Bachstraße 290",
      "name" : "Rechnungsstelle"
    },
    "emailAddresses" : {
      "main" : "info@fuchs-gmbh.example.org"
    },
    "phoneNumbers" : {
      "office" : "+49 89 99998009"
    }
  }
} ]

UseCase Add Demo Relation => REPRESENTATIVE: Christian Fuchs - Vertretung (P-90003)

Properties

Given

name	value
partnerPersonName	Fuchs GmbH
relationType	REPRESENTATIVE
holderGivenName	Christian
holderFamilyName	Fuchs
contactCaption	Christian Fuchs - Vertretung (P-90003)
postalAddress	“street”: “Heideweg 441”, “zipcode”: “10115”, “city”: “Berlin”, “country”: “Germany”
phoneNumber	+49 30 23125540
emailAddress	christian-fuchs@fuchs-gmbh.example.org

Person: Christian Fuchs

HTTP POST "/api/hs/office/persons" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY" \
  <<EOF
{
  "personType" : "NATURAL_PERSON",
  "familyName" : "Fuchs",
  "givenName" : "Christian"
}
EOF
=> status: 201 CREATED 04891615-acc6-477a-b67b-5e88efd9401b

Contact: Christian Fuchs - Vertretung (P-90003)

HTTP POST "/api/hs/office/contacts" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY" \
  <<EOF
{
  "caption" : "Christian Fuchs - Vertretung (P-90003)",
  "postalAddress" : {
    "street" : "Heideweg 441",
    "zipcode" : "10115",
    "city" : "Berlin",
    "country" : "Germany"
  },
  "phoneNumbers" : {
    "office" : "+49 30 23125540"
  },
  "emailAddresses" : {
    "main" : "christian-fuchs@fuchs-gmbh.example.org"
  }
}
EOF
=> status: 201 CREATED e738d00a-1df4-4c00-94af-bf4e7000316e

Create REPRESENTATIVE: Christian Fuchs - Vertretung (P-90003)

HTTP POST "/api/hs/office/relations" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY" \
  <<EOF
{
  "type" : "REPRESENTATIVE",
  "anchor.uuid" : "d689405e-aea5-457a-a577-09a0b1887151", // Person: Fuchs GmbH
  "holder.uuid" : "04891615-acc6-477a-b67b-5e88efd9401b", // Person: Christian Fuchs
  "contact.uuid" : "e738d00a-1df4-4c00-94af-bf4e7000316e" // Contact: Christian Fuchs - Vertretung (P-90003)
}
EOF
=> status: 201 CREATED 114cf9cd-74d7-48e6-8803-6ae47ec664f4

Verify the Relation Got Created

HTTP GET "/api/hs/office/relations/114cf9cd-74d7-48e6-8803-6ae47ec664f4" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY"
=> status: 200 OK 
{
  "uuid" : "114cf9cd-74d7-48e6-8803-6ae47ec664f4",
  "anchor" : {
    "uuid" : "d689405e-aea5-457a-a577-09a0b1887151", // Person: Fuchs GmbH
    "personType" : "LEGAL_PERSON",
    "tradeName" : "Fuchs GmbH",
    "salutation" : null,
    "title" : null,
    "givenName" : null,
    "familyName" : null
  },
  "holder" : {
    "uuid" : "04891615-acc6-477a-b67b-5e88efd9401b", // Person: Christian Fuchs
    "personType" : "NATURAL_PERSON",
    "tradeName" : null,
    "salutation" : null,
    "title" : null,
    "givenName" : "Christian",
    "familyName" : "Fuchs"
  },
  "type" : "REPRESENTATIVE",
  "mark" : null,
  "contact" : {
    "uuid" : "e738d00a-1df4-4c00-94af-bf4e7000316e", // Contact: Christian Fuchs - Vertretung (P-90003)
    "caption" : "Christian Fuchs - Vertretung (P-90003)",
    "postalAddress" : {
      "zipcode" : "10115",
      "country" : "Germany",
      "city" : "Berlin",
      "street" : "Heideweg 441"
    },
    "emailAddresses" : {
      "main" : "christian-fuchs@fuchs-gmbh.example.org"
    },
    "phoneNumbers" : {
      "office" : "+49 30 23125540"
    }
  }
}

UseCase Add Demo Relation => OPERATIONS: Gabriele Meyer - Technik (P-90003)

Properties

Given

name	value
partnerPersonName	Fuchs GmbH
relationType	OPERATIONS
holderGivenName	Gabriele
holderFamilyName	Meyer
contactCaption	Gabriele Meyer - Technik (P-90003)
postalAddress	“street”: “Wiesengrund 118”, “zipcode”: “28195”, “city”: “Bremen”, “country”: “Germany”
phoneNumber	+49 171 3920029
emailAddress	gabriele-meyer@fuchs-gmbh.example.org

Person: Gabriele Meyer

HTTP POST "/api/hs/office/persons" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY" \
  <<EOF
{
  "personType" : "NATURAL_PERSON",
  "familyName" : "Meyer",
  "givenName" : "Gabriele"
}
EOF
=> status: 201 CREATED af2c09f5-a541-4ab7-8ed8-8945aef89976

Contact: Gabriele Meyer - Technik (P-90003)

HTTP POST "/api/hs/office/contacts" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY" \
  <<EOF
{
  "caption" : "Gabriele Meyer - Technik (P-90003)",
  "postalAddress" : {
    "street" : "Wiesengrund 118",
    "zipcode" : "28195",
    "city" : "Bremen",
    "country" : "Germany"
  },
  "phoneNumbers" : {
    "office" : "+49 171 3920029"
  },
  "emailAddresses" : {
    "main" : "gabriele-meyer@fuchs-gmbh.example.org"
  }
}
EOF
=> status: 201 CREATED 81ed569b-93a8-4097-b2f9-b65b7f5b05cd

Create OPERATIONS: Gabriele Meyer - Technik (P-90003)

HTTP POST "/api/hs/office/relations" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY" \
  <<EOF
{
  "type" : "OPERATIONS",
  "anchor.uuid" : "d689405e-aea5-457a-a577-09a0b1887151", // Person: Fuchs GmbH
  "holder.uuid" : "af2c09f5-a541-4ab7-8ed8-8945aef89976", // Person: Gabriele Meyer
  "contact.uuid" : "81ed569b-93a8-4097-b2f9-b65b7f5b05cd" // Contact: Gabriele Meyer - Technik (P-90003)
}
EOF
=> status: 201 CREATED a1a37d73-dbbd-401b-8a6c-61312086b47d

Verify the Relation Got Created

HTTP GET "/api/hs/office/relations/a1a37d73-dbbd-401b-8a6c-61312086b47d" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY"
=> status: 200 OK 
{
  "uuid" : "a1a37d73-dbbd-401b-8a6c-61312086b47d",
  "anchor" : {
    "uuid" : "d689405e-aea5-457a-a577-09a0b1887151", // Person: Fuchs GmbH
    "personType" : "LEGAL_PERSON",
    "tradeName" : "Fuchs GmbH",
    "salutation" : null,
    "title" : null,
    "givenName" : null,
    "familyName" : null
  },
  "holder" : {
    "uuid" : "af2c09f5-a541-4ab7-8ed8-8945aef89976", // Person: Gabriele Meyer
    "personType" : "NATURAL_PERSON",
    "tradeName" : null,
    "salutation" : null,
    "title" : null,
    "givenName" : "Gabriele",
    "familyName" : "Meyer"
  },
  "type" : "OPERATIONS",
  "mark" : null,
  "contact" : {
    "uuid" : "81ed569b-93a8-4097-b2f9-b65b7f5b05cd", // Contact: Gabriele Meyer - Technik (P-90003)
    "caption" : "Gabriele Meyer - Technik (P-90003)",
    "postalAddress" : {
      "zipcode" : "28195",
      "country" : "Germany",
      "city" : "Bremen",
      "street" : "Wiesengrund 118"
    },
    "emailAddresses" : {
      "main" : "gabriele-meyer@fuchs-gmbh.example.org"
    },
    "phoneNumbers" : {
      "office" : "+49 171 3920029"
    }
  }
}

UseCase Create Demo Debitor => Debitor: Fuchs GmbH - Rechnungsstelle (D-9000300)

Properties

Given

name	value
partnerPersonName	Fuchs GmbH
debitorNumberSuffix	00
billable	true
vatBusiness	true
defaultPrefix	aae
bankAccountHolder	Fuchs GmbH (P-90003/0)
iban	DE44990300000591816846
bic	DEMRDEF0
billingContactCaption	Fuchs GmbH - Rechnungsstelle (D-9000300)
billingContactEmailAddress	rechnung0@fuchs-gmbh.example.org

BankAccount: Fuchs GmbH (P-90003/0)

HTTP POST "/api/hs/office/bankaccounts" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY" \
  <<EOF
{
  "holder" : "Fuchs GmbH (P-90003/0)",
  "iban" : "DE44990300000591816846",
  "bic" : "DEMRDEF0"
}
EOF
=> status: 201 CREATED e32f1116-0581-442c-96f7-1ba341b2a8f8

Contact: Fuchs GmbH - Rechnungsstelle (D-9000300)

HTTP POST "/api/hs/office/contacts" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY" \
  <<EOF
{
  "caption" : "Fuchs GmbH - Rechnungsstelle (D-9000300)",
  "emailAddresses" : {
    "main" : "rechnung0@fuchs-gmbh.example.org"
  }
}
EOF
=> status: 201 CREATED 98d8351d-e7dc-4acc-9898-c4fce6f3f170

Create Debitor: Fuchs GmbH - Rechnungsstelle (D-9000300)

HTTP POST "/api/hs/office/debitors" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY" \
  <<EOF
{
  "debitorRel" : {
    "anchor.uuid" : "d689405e-aea5-457a-a577-09a0b1887151", // Person: Fuchs GmbH
    "holder.uuid" : "d689405e-aea5-457a-a577-09a0b1887151", // Person: Fuchs GmbH
    "contact.uuid" : "98d8351d-e7dc-4acc-9898-c4fce6f3f170" // Contact: Fuchs GmbH - Rechnungsstelle (D-9000300)
  },
  "debitorNumberSuffix" : "00",
  "billable" : true,
  "vatBusiness" : true,
  "vatReverseCharge" : false,
  "refundBankAccount.uuid" : "e32f1116-0581-442c-96f7-1ba341b2a8f8", // BankAccount: Fuchs GmbH (P-90003/0)
  "defaultPrefix" : "aae"
}
EOF
=> status: 201 CREATED f1bee391-a9a2-4e58-9384-9012814a2b20

Verify the Debitor Got Created

HTTP GET "/api/hs/office/debitors/f1bee391-a9a2-4e58-9384-9012814a2b20" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY"
=> status: 200 OK 
{
  "uuid" : "f1bee391-a9a2-4e58-9384-9012814a2b20",
  "debitorRel" : {
    "uuid" : "782899ae-7ee2-468d-acfc-7ec7e8c8cd4f",
    "anchor" : {
      "uuid" : "d689405e-aea5-457a-a577-09a0b1887151", // Person: Fuchs GmbH
      "personType" : "LEGAL_PERSON",
      "tradeName" : "Fuchs GmbH",
      "salutation" : null,
      "title" : null,
      "givenName" : null,
      "familyName" : null
    },
    "holder" : {
      "uuid" : "d689405e-aea5-457a-a577-09a0b1887151", // Person: Fuchs GmbH
      "personType" : "LEGAL_PERSON",
      "tradeName" : "Fuchs GmbH",
      "salutation" : null,
      "title" : null,
      "givenName" : null,
      "familyName" : null
    },
    "type" : "DEBITOR",
    "mark" : null,
    "contact" : {
      "uuid" : "98d8351d-e7dc-4acc-9898-c4fce6f3f170", // Contact: Fuchs GmbH - Rechnungsstelle (D-9000300)
      "caption" : "Fuchs GmbH - Rechnungsstelle (D-9000300)",
      "postalAddress" : { },
      "emailAddresses" : {
        "main" : "rechnung0@fuchs-gmbh.example.org"
      },
      "phoneNumbers" : { }
    }
  },
  "debitorNumber" : "D-9000300",
  "debitorNumberSuffix" : "00",
  "partner" : {
    "uuid" : "7a476b6b-bc74-4960-858c-598f281f6aae",
    "partnerNumber" : "P-90003",
    "partnerRel" : {
      "uuid" : "e4560db0-e29d-4a19-b99c-fa0fbc1195e6",
      "anchor" : {
        "uuid" : "0ef98191-79d8-443e-89c1-1076e8f6df80", // Person: Hostsharing eG
        "personType" : "LEGAL_PERSON",
        "tradeName" : "Hostsharing eG",
        "salutation" : null,
        "title" : null,
        "givenName" : null,
        "familyName" : null
      },
      "holder" : {
        "uuid" : "d689405e-aea5-457a-a577-09a0b1887151", // Person: Fuchs GmbH
        "personType" : "LEGAL_PERSON",
        "tradeName" : "Fuchs GmbH",
        "salutation" : null,
        "title" : null,
        "givenName" : null,
        "familyName" : null
      },
      "type" : "PARTNER",
      "mark" : null,
      "contact" : {
        "uuid" : "214d3c9b-ab48-4514-ba5a-e0c20e5c5c7e", // Contact: Fuchs GmbH - Hauptkontakt (P-90003)
        "caption" : "Fuchs GmbH - Hauptkontakt (P-90003)",
        "postalAddress" : {
          "zipcode" : "80331",
          "country" : "Germany",
          "city" : "München",
          "street" : "Bachstraße 290",
          "name" : "Rechnungsstelle"
        },
        "emailAddresses" : {
          "main" : "info@fuchs-gmbh.example.org"
        },
        "phoneNumbers" : {
          "office" : "+49 89 99998009"
        }
      }
    },
    "details" : {
      "uuid" : "8233b9fc-164e-4ad2-83f0-442940450fd8",
      "registrationOffice" : "Registergericht München",
      "registrationNumber" : "322619",
      "birthName" : null,
      "birthPlace" : null,
      "birthday" : null,
      "dateOfDeath" : null
    }
  },
  "billable" : true,
  "vatId" : null,
  "vatCountryCode" : null,
  "vatBusiness" : true,
  "vatReverseCharge" : false,
  "refundBankAccount" : {
    "uuid" : "e32f1116-0581-442c-96f7-1ba341b2a8f8", // BankAccount: Fuchs GmbH (P-90003/0)
    "holder" : "Fuchs GmbH (P-90003/0)",
    "iban" : "DE44990300000591816846",
    "bic" : "DEMRDEF0"
  },
  "defaultPrefix" : "aae"
}

UseCase Create Membership => Membership: Fuchs GmbH

Properties

Given

name	value
partnerNumber	P-90003
validFrom	2002-02-07
membershipFeeBillable	true

Partner: P-90003

HTTP GET "/api/hs/office/partners/P-90003" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY"
=> status: 200 OK 
{
  "uuid" : "7a476b6b-bc74-4960-858c-598f281f6aae",
  "partnerNumber" : "P-90003",
  "partnerRel" : {
    "uuid" : "e4560db0-e29d-4a19-b99c-fa0fbc1195e6",
    "anchor" : {
      "uuid" : "0ef98191-79d8-443e-89c1-1076e8f6df80", // Person: Hostsharing eG
      "personType" : "LEGAL_PERSON",
      "tradeName" : "Hostsharing eG",
      "salutation" : null,
      "title" : null,
      "givenName" : null,
      "familyName" : null
    },
    "holder" : {
      "uuid" : "d689405e-aea5-457a-a577-09a0b1887151", // Person: Fuchs GmbH
      "personType" : "LEGAL_PERSON",
      "tradeName" : "Fuchs GmbH",
      "salutation" : null,
      "title" : null,
      "givenName" : null,
      "familyName" : null
    },
    "type" : "PARTNER",
    "mark" : null,
    "contact" : {
      "uuid" : "214d3c9b-ab48-4514-ba5a-e0c20e5c5c7e", // Contact: Fuchs GmbH - Hauptkontakt (P-90003)
      "caption" : "Fuchs GmbH - Hauptkontakt (P-90003)",
      "postalAddress" : {
        "zipcode" : "80331",
        "country" : "Germany",
        "city" : "München",
        "street" : "Bachstraße 290",
        "name" : "Rechnungsstelle"
      },
      "emailAddresses" : {
        "main" : "info@fuchs-gmbh.example.org"
      },
      "phoneNumbers" : {
        "office" : "+49 89 99998009"
      }
    }
  },
  "details" : {
    "uuid" : "8233b9fc-164e-4ad2-83f0-442940450fd8",
    "registrationOffice" : "Registergericht München",
    "registrationNumber" : "322619",
    "birthName" : null,
    "birthPlace" : null,
    "birthday" : null,
    "dateOfDeath" : null
  }
}

The partner-number identifies the partner; a lookup by name could not, because a natural person carries its name in two columns and any name can be the prefix of a longer one.

Create Membership: Fuchs GmbH

HTTP POST "/api/hs/office/memberships" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY" \
  <<EOF
{
  "partner.uuid" : "7a476b6b-bc74-4960-858c-598f281f6aae", // Partner: P-90003
  "memberNumberSuffix" : "00",
  "status" : "ACTIVE",
  "validFrom" : "2002-02-07",
  "membershipFeeBillable" : true
}
EOF
=> status: 201 CREATED 41b73698-3344-4c04-b68b-4651826da896

Verify That the Membership Got Created

HTTP GET "/api/hs/office/memberships/41b73698-3344-4c04-b68b-4651826da896" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY"
=> status: 200 OK 
{
  "uuid" : "41b73698-3344-4c04-b68b-4651826da896",
  "partner" : {
    "uuid" : "7a476b6b-bc74-4960-858c-598f281f6aae", // Partner: P-90003
    "partnerNumber" : "P-90003",
    "partnerRel" : {
      "uuid" : "e4560db0-e29d-4a19-b99c-fa0fbc1195e6",
      "anchor" : {
        "uuid" : "0ef98191-79d8-443e-89c1-1076e8f6df80", // Person: Hostsharing eG
        "personType" : "LEGAL_PERSON",
        "tradeName" : "Hostsharing eG",
        "salutation" : null,
        "title" : null,
        "givenName" : null,
        "familyName" : null
      },
      "holder" : {
        "uuid" : "d689405e-aea5-457a-a577-09a0b1887151", // Person: Fuchs GmbH
        "personType" : "LEGAL_PERSON",
        "tradeName" : "Fuchs GmbH",
        "salutation" : null,
        "title" : null,
        "givenName" : null,
        "familyName" : null
      },
      "type" : "PARTNER",
      "mark" : null,
      "contact" : {
        "uuid" : "214d3c9b-ab48-4514-ba5a-e0c20e5c5c7e", // Contact: Fuchs GmbH - Hauptkontakt (P-90003)
        "caption" : "Fuchs GmbH - Hauptkontakt (P-90003)",
        "postalAddress" : {
          "zipcode" : "80331",
          "country" : "Germany",
          "city" : "München",
          "street" : "Bachstraße 290",
          "name" : "Rechnungsstelle"
        },
        "emailAddresses" : {
          "main" : "info@fuchs-gmbh.example.org"
        },
        "phoneNumbers" : {
          "office" : "+49 89 99998009"
        }
      }
    },
    "details" : {
      "uuid" : "8233b9fc-164e-4ad2-83f0-442940450fd8",
      "registrationOffice" : "Registergericht München",
      "registrationNumber" : "322619",
      "birthName" : null,
      "birthPlace" : null,
      "birthday" : null,
      "dateOfDeath" : null
    }
  },
  "mainDebitor" : null,
  "memberNumber" : "M-9000300",
  "memberNumberSuffix" : "00",
  "validFrom" : "2002-02-07",
  "validTo" : null,
  "status" : "ACTIVE",
  "membershipFeeBillable" : true
}

Properties

Given

name	value
transactionType	SUBSCRIPTION
memberNumber	M-9000300
reference	sign 2002-02-07
shareCount	38
comment	initial shares on joining
transactionDate	2002-02-07

Find membershipUuid

HTTP GET "/api/hs/office/memberships/M-9000300" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY"
=> status: 200 OK 
{
  "uuid" : "41b73698-3344-4c04-b68b-4651826da896",
  "partner" : {
    "uuid" : "7a476b6b-bc74-4960-858c-598f281f6aae", // Partner: P-90003
    "partnerNumber" : "P-90003",
    "partnerRel" : {
      "uuid" : "e4560db0-e29d-4a19-b99c-fa0fbc1195e6",
      "anchor" : {
        "uuid" : "0ef98191-79d8-443e-89c1-1076e8f6df80", // Person: Hostsharing eG
        "personType" : "LEGAL_PERSON",
        "tradeName" : "Hostsharing eG",
        "salutation" : null,
        "title" : null,
        "givenName" : null,
        "familyName" : null
      },
      "holder" : {
        "uuid" : "d689405e-aea5-457a-a577-09a0b1887151", // Person: Fuchs GmbH
        "personType" : "LEGAL_PERSON",
        "tradeName" : "Fuchs GmbH",
        "salutation" : null,
        "title" : null,
        "givenName" : null,
        "familyName" : null
      },
      "type" : "PARTNER",
      "mark" : null,
      "contact" : {
        "uuid" : "214d3c9b-ab48-4514-ba5a-e0c20e5c5c7e", // Contact: Fuchs GmbH - Hauptkontakt (P-90003)
        "caption" : "Fuchs GmbH - Hauptkontakt (P-90003)",
        "postalAddress" : {
          "zipcode" : "80331",
          "country" : "Germany",
          "city" : "München",
          "street" : "Bachstraße 290",
          "name" : "Rechnungsstelle"
        },
        "emailAddresses" : {
          "main" : "info@fuchs-gmbh.example.org"
        },
        "phoneNumbers" : {
          "office" : "+49 89 99998009"
        }
      }
    },
    "details" : {
      "uuid" : "8233b9fc-164e-4ad2-83f0-442940450fd8",
      "registrationOffice" : "Registergericht München",
      "registrationNumber" : "322619",
      "birthName" : null,
      "birthPlace" : null,
      "birthday" : null,
      "dateOfDeath" : null
    }
  },
  "mainDebitor" : null,
  "memberNumber" : "M-9000300",
  "memberNumberSuffix" : "00",
  "validFrom" : "2002-02-07",
  "validTo" : null,
  "status" : "ACTIVE",
  "membershipFeeBillable" : true
}

Create the Coop-Shares-SUBSCRIPTION Transaction

HTTP POST "/api/hs/office/coopsharestransactions" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY" \
  <<EOF
{
  "membership.uuid" : "41b73698-3344-4c04-b68b-4651826da896", // membershipUuid
  "transactionType" : "SUBSCRIPTION",
  "reference" : "sign 2002-02-07",
  "shareCount" : 38,
  "comment" : "initial shares on joining",
  "valueDate" : "2002-02-07"
}
EOF
=> status: 201 CREATED 7ff0a794-b7b4-4430-91ee-9d0c081937c4

Verify Coop-Shares SUBSCRIPTION-Transaction

HTTP GET "/api/hs/office/coopsharestransactions/7ff0a794-b7b4-4430-91ee-9d0c081937c4" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY"
=> status: 200 OK 
{
  "uuid" : "7ff0a794-b7b4-4430-91ee-9d0c081937c4",
  "membership.uuid" : "41b73698-3344-4c04-b68b-4651826da896", // membershipUuid
  "transactionType" : "SUBSCRIPTION",
  "shareCount" : 38,
  "valueDate" : "2002-02-07",
  "reference" : "sign 2002-02-07",
  "comment" : "initial shares on joining",
  "revertedShareTx" : null,
  "reversalShareTx" : null
}

Properties

Given

name	value
transactionType	DEPOSIT
memberNumber	M-9000300
reference	sign 2002-02-07
assetValue	2432
comment	deposit for initial shares
transactionDate	2002-02-17

Find membershipUuid

HTTP GET "/api/hs/office/memberships/M-9000300" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY"
=> status: 200 OK 
{
  "uuid" : "41b73698-3344-4c04-b68b-4651826da896", // membershipUuid
  "partner" : {
    "uuid" : "7a476b6b-bc74-4960-858c-598f281f6aae", // Partner: P-90003
    "partnerNumber" : "P-90003",
    "partnerRel" : {
      "uuid" : "e4560db0-e29d-4a19-b99c-fa0fbc1195e6",
      "anchor" : {
        "uuid" : "0ef98191-79d8-443e-89c1-1076e8f6df80", // Person: Hostsharing eG
        "personType" : "LEGAL_PERSON",
        "tradeName" : "Hostsharing eG",
        "salutation" : null,
        "title" : null,
        "givenName" : null,
        "familyName" : null
      },
      "holder" : {
        "uuid" : "d689405e-aea5-457a-a577-09a0b1887151", // Person: Fuchs GmbH
        "personType" : "LEGAL_PERSON",
        "tradeName" : "Fuchs GmbH",
        "salutation" : null,
        "title" : null,
        "givenName" : null,
        "familyName" : null
      },
      "type" : "PARTNER",
      "mark" : null,
      "contact" : {
        "uuid" : "214d3c9b-ab48-4514-ba5a-e0c20e5c5c7e", // Contact: Fuchs GmbH - Hauptkontakt (P-90003)
        "caption" : "Fuchs GmbH - Hauptkontakt (P-90003)",
        "postalAddress" : {
          "zipcode" : "80331",
          "country" : "Germany",
          "city" : "München",
          "street" : "Bachstraße 290",
          "name" : "Rechnungsstelle"
        },
        "emailAddresses" : {
          "main" : "info@fuchs-gmbh.example.org"
        },
        "phoneNumbers" : {
          "office" : "+49 89 99998009"
        }
      }
    },
    "details" : {
      "uuid" : "8233b9fc-164e-4ad2-83f0-442940450fd8",
      "registrationOffice" : "Registergericht München",
      "registrationNumber" : "322619",
      "birthName" : null,
      "birthPlace" : null,
      "birthday" : null,
      "dateOfDeath" : null
    }
  },
  "mainDebitor" : null,
  "memberNumber" : "M-9000300",
  "memberNumberSuffix" : "00",
  "validFrom" : "2002-02-07",
  "validTo" : null,
  "status" : "ACTIVE",
  "membershipFeeBillable" : true
}

Create the Coop-Assets-DEPOSIT Transaction

HTTP POST "/api/hs/office/coopassetstransactions" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY" \
  <<EOF
{
  "membership.uuid" : "41b73698-3344-4c04-b68b-4651826da896", // membershipUuid
  "transactionType" : "DEPOSIT",
  "reference" : "sign 2002-02-07",
  "assetValue" : 2432,
  "comment" : "deposit for initial shares",
  "valueDate" : "2002-02-17"
}
EOF
=> status: 201 CREATED a616195b-8bba-4bcf-b1d8-53891aaa9518

Verify Coop-Assets DEPOSIT-Transaction

HTTP GET "/api/hs/office/coopassetstransactions/a616195b-8bba-4bcf-b1d8-53891aaa9518" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY"
=> status: 200 OK 
{
  "uuid" : "a616195b-8bba-4bcf-b1d8-53891aaa9518",
  "membership.uuid" : "41b73698-3344-4c04-b68b-4651826da896", // membershipUuid
  "membership.memberNumber" : "M-9000300",
  "transactionType" : "DEPOSIT",
  "assetValue" : 2432,
  "valueDate" : "2002-02-17",
  "reference" : "sign 2002-02-07",
  "comment" : "deposit for initial shares",
  "adoptionAssetTx" : null,
  "transferAssetTx" : null,
  "revertedAssetTx" : null,
  "reversalAssetTx" : null
}

Contact: Christian Fuchs - private Mailinglisten-Adresse

HTTP POST "/api/hs/office/contacts" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY" \
  <<EOF
{
  "caption" : "Christian Fuchs - private Mailinglisten-Adresse",
  "postalAddress" : {
    "street" : "Blumenstraße 234",
    "zipcode" : "30159",
    "city" : "Hannover",
    "country" : "Germany"
  },
  "phoneNumbers" : {
    "main" : "+49 171 3920060"
  },
  "emailAddresses" : {
    "main" : "christian-fuchs@example.net"
  }
}
EOF
=> status: 201 CREATED 6e1dac83-a7e8-42c1-9d04-bb23c6bbf583

UseCase Add Demo Subscription => SUBSCRIBER generalversammlung: Christian Fuchs (P-90003)

Properties

Given

name	value
partnerPersonName	Fuchs GmbH
mailingList	generalversammlung
holderGivenName	Christian
holderFamilyName	Fuchs
contactCaption	Christian Fuchs - private Mailinglisten-Adresse

Create SUBSCRIBER generalversammlung: Christian Fuchs (P-90003)

HTTP POST "/api/hs/office/relations" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY" \
  <<EOF
{
  "type" : "SUBSCRIBER",
  "mark" : "generalversammlung",
  "anchor.uuid" : "d689405e-aea5-457a-a577-09a0b1887151", // Person: Fuchs GmbH
  "holder.uuid" : "04891615-acc6-477a-b67b-5e88efd9401b", // Person: Christian Fuchs
  "contact.uuid" : "6e1dac83-a7e8-42c1-9d04-bb23c6bbf583" // Contact: Christian Fuchs - private Mailinglisten-Adresse
}
EOF
=> status: 201 CREATED 64a1b6f1-0b1e-461c-ae18-77637d42f098

Verify the Subscription Got Created

HTTP GET "/api/hs/office/relations/64a1b6f1-0b1e-461c-ae18-77637d42f098" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY"
=> status: 200 OK 
{
  "uuid" : "64a1b6f1-0b1e-461c-ae18-77637d42f098",
  "anchor" : {
    "uuid" : "d689405e-aea5-457a-a577-09a0b1887151", // Person: Fuchs GmbH
    "personType" : "LEGAL_PERSON",
    "tradeName" : "Fuchs GmbH",
    "salutation" : null,
    "title" : null,
    "givenName" : null,
    "familyName" : null
  },
  "holder" : {
    "uuid" : "04891615-acc6-477a-b67b-5e88efd9401b", // Person: Christian Fuchs
    "personType" : "NATURAL_PERSON",
    "tradeName" : null,
    "salutation" : null,
    "title" : null,
    "givenName" : "Christian",
    "familyName" : "Fuchs"
  },
  "type" : "SUBSCRIBER",
  "mark" : "generalversammlung",
  "contact" : {
    "uuid" : "6e1dac83-a7e8-42c1-9d04-bb23c6bbf583", // Contact: Christian Fuchs - private Mailinglisten-Adresse
    "caption" : "Christian Fuchs - private Mailinglisten-Adresse",
    "postalAddress" : {
      "zipcode" : "30159",
      "country" : "Germany",
      "city" : "Hannover",
      "street" : "Blumenstraße 234"
    },
    "emailAddresses" : {
      "main" : "christian-fuchs@example.net"
    },
    "phoneNumbers" : {
      "main" : "+49 171 3920060"
    }
  }
}

UseCase Add Demo Subscription => SUBSCRIBER members-announce: Christian Fuchs (P-90003)

Properties

Given

name	value
partnerPersonName	Fuchs GmbH
mailingList	members-announce
holderGivenName	Christian
holderFamilyName	Fuchs
contactCaption	Christian Fuchs - private Mailinglisten-Adresse

Create SUBSCRIBER members-announce: Christian Fuchs (P-90003)

HTTP POST "/api/hs/office/relations" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY" \
  <<EOF
{
  "type" : "SUBSCRIBER",
  "mark" : "members-announce",
  "anchor.uuid" : "d689405e-aea5-457a-a577-09a0b1887151", // Person: Fuchs GmbH
  "holder.uuid" : "04891615-acc6-477a-b67b-5e88efd9401b", // Person: Christian Fuchs
  "contact.uuid" : "6e1dac83-a7e8-42c1-9d04-bb23c6bbf583" // Contact: Christian Fuchs - private Mailinglisten-Adresse
}
EOF
=> status: 201 CREATED 6208d69a-4513-4db3-bd4d-c2aa215daf50

Verify the Subscription Got Created

HTTP GET "/api/hs/office/relations/6208d69a-4513-4db3-bd4d-c2aa215daf50" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY"
=> status: 200 OK 
{
  "uuid" : "6208d69a-4513-4db3-bd4d-c2aa215daf50",
  "anchor" : {
    "uuid" : "d689405e-aea5-457a-a577-09a0b1887151", // Person: Fuchs GmbH
    "personType" : "LEGAL_PERSON",
    "tradeName" : "Fuchs GmbH",
    "salutation" : null,
    "title" : null,
    "givenName" : null,
    "familyName" : null
  },
  "holder" : {
    "uuid" : "04891615-acc6-477a-b67b-5e88efd9401b", // Person: Christian Fuchs
    "personType" : "NATURAL_PERSON",
    "tradeName" : null,
    "salutation" : null,
    "title" : null,
    "givenName" : "Christian",
    "familyName" : "Fuchs"
  },
  "type" : "SUBSCRIBER",
  "mark" : "members-announce",
  "contact" : {
    "uuid" : "6e1dac83-a7e8-42c1-9d04-bb23c6bbf583", // Contact: Christian Fuchs - private Mailinglisten-Adresse
    "caption" : "Christian Fuchs - private Mailinglisten-Adresse",
    "postalAddress" : {
      "zipcode" : "30159",
      "country" : "Germany",
      "city" : "Hannover",
      "street" : "Blumenstraße 234"
    },
    "emailAddresses" : {
      "main" : "christian-fuchs@example.net"
    },
    "phoneNumbers" : {
      "main" : "+49 171 3920060"
    }
  }
}

UseCase Add Demo Subscription => SUBSCRIBER customers-announce: Christian Fuchs (P-90003)

Properties

Given

name	value
partnerPersonName	Fuchs GmbH
mailingList	customers-announce
holderGivenName	Christian
holderFamilyName	Fuchs
contactCaption	Christian Fuchs - private Mailinglisten-Adresse

Create SUBSCRIBER customers-announce: Christian Fuchs (P-90003)

HTTP POST "/api/hs/office/relations" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY" \
  <<EOF
{
  "type" : "SUBSCRIBER",
  "mark" : "customers-announce",
  "anchor.uuid" : "d689405e-aea5-457a-a577-09a0b1887151", // Person: Fuchs GmbH
  "holder.uuid" : "04891615-acc6-477a-b67b-5e88efd9401b", // Person: Christian Fuchs
  "contact.uuid" : "6e1dac83-a7e8-42c1-9d04-bb23c6bbf583" // Contact: Christian Fuchs - private Mailinglisten-Adresse
}
EOF
=> status: 201 CREATED 3b6434f7-c8a2-413c-8dc4-d5f23bd4ac12

Verify the Subscription Got Created

HTTP GET "/api/hs/office/relations/3b6434f7-c8a2-413c-8dc4-d5f23bd4ac12" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY"
=> status: 200 OK 
{
  "uuid" : "3b6434f7-c8a2-413c-8dc4-d5f23bd4ac12",
  "anchor" : {
    "uuid" : "d689405e-aea5-457a-a577-09a0b1887151", // Person: Fuchs GmbH
    "personType" : "LEGAL_PERSON",
    "tradeName" : "Fuchs GmbH",
    "salutation" : null,
    "title" : null,
    "givenName" : null,
    "familyName" : null
  },
  "holder" : {
    "uuid" : "04891615-acc6-477a-b67b-5e88efd9401b", // Person: Christian Fuchs
    "personType" : "NATURAL_PERSON",
    "tradeName" : null,
    "salutation" : null,
    "title" : null,
    "givenName" : "Christian",
    "familyName" : "Fuchs"
  },
  "type" : "SUBSCRIBER",
  "mark" : "customers-announce",
  "contact" : {
    "uuid" : "6e1dac83-a7e8-42c1-9d04-bb23c6bbf583", // Contact: Christian Fuchs - private Mailinglisten-Adresse
    "caption" : "Christian Fuchs - private Mailinglisten-Adresse",
    "postalAddress" : {
      "zipcode" : "30159",
      "country" : "Germany",
      "city" : "Hannover",
      "street" : "Blumenstraße 234"
    },
    "emailAddresses" : {
      "main" : "christian-fuchs@example.net"
    },
    "phoneNumbers" : {
      "main" : "+49 171 3920060"
    }
  }
}

UseCase Create Partner => Partner: P-90004 - Schäfer Elektro GmbH

Properties

Given

name	value
partnerNumber	P-90004
personType	LEGAL_PERSON
contactCaption	Schäfer Elektro GmbH - Hauptkontakt (P-90004)
postalAddress	“name”: “Buchhaltung”, “street”: “Veilchenweg 528”, “zipcode”: “44135”, “city”: “Dortmund”, “country”: “Germany”
officePhoneNumber	+49 176 04069082
emailAddress	info@schaefer-elektro-gmbh.example.org
tradeName	Schäfer Elektro GmbH
registrationOffice	Registergericht Dortmund
registrationNumber	619312

Person: Hostsharing eG

HTTP GET "/api/hs/office/persons?name=Hostsharing+eG" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY"
=> status: 200 OK 
[ {
  "uuid" : "0ef98191-79d8-443e-89c1-1076e8f6df80", // Person: Hostsharing eG
  "personType" : "LEGAL_PERSON",
  "tradeName" : "Hostsharing eG",
  "salutation" : null,
  "title" : null,
  "givenName" : null,
  "familyName" : null
} ]

Even in production data we expect this query to return just a single result.

Person: Schäfer Elektro GmbH

HTTP POST "/api/hs/office/persons" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY" \
  <<EOF
{
  "personType" : "LEGAL_PERSON",
  "tradeName" : "Schäfer Elektro GmbH"
}
EOF
=> status: 201 CREATED 7c06beef-0447-4b79-b629-40584c4d6e2e

Contact: Schäfer Elektro GmbH - Hauptkontakt (P-90004)

HTTP POST "/api/hs/office/contacts" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY" \
  <<EOF
{
  "caption" : "Schäfer Elektro GmbH - Hauptkontakt (P-90004)",
  "postalAddress" : {
    "name" : "Buchhaltung",
    "street" : "Veilchenweg 528",
    "zipcode" : "44135",
    "city" : "Dortmund",
    "country" : "Germany"
  },
  "phoneNumbers" : {
    "office" : "+49 176 04069082"
  },
  "emailAddresses" : {
    "main" : "info@schaefer-elektro-gmbh.example.org"
  }
}
EOF
=> status: 201 CREATED c17a94a1-8590-4291-b4fe-ba36f9c7012c

Create Partner: P-90004 - Schäfer Elektro GmbH

HTTP POST "/api/hs/office/partners" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY" \
  <<EOF
{
  "partnerNumber" : "P-90004",
  "partnerRel" : {
    "anchor.uuid" : "0ef98191-79d8-443e-89c1-1076e8f6df80", // Person: Hostsharing eG
    "holder.uuid" : "7c06beef-0447-4b79-b629-40584c4d6e2e", // Person: Schäfer Elektro GmbH
    "contact.uuid" : "c17a94a1-8590-4291-b4fe-ba36f9c7012c" // Contact: Schäfer Elektro GmbH - Hauptkontakt (P-90004)
  },
  "details" : {
    "registrationOffice" : "Registergericht Dortmund",
    "registrationNumber" : "619312"
  }
}
EOF
=> status: 201 CREATED 14e3f0a0-adae-492b-81b3-ccd3eec4fe13

Verify the New Partner Relation

HTTP GET "/api/hs/office/relations?relationType=PARTNER&contactData=Sch%C3%A4fer+Elektro+GmbH+-+Hauptkontakt+%28P-90004%29" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY"
=> status: 200 OK 
[ {
  "uuid" : "28fd0921-8a8e-4d2f-808b-1989b6c6f6a5",
  "anchor" : {
    "uuid" : "0ef98191-79d8-443e-89c1-1076e8f6df80", // Person: Hostsharing eG
    "personType" : "LEGAL_PERSON",
    "tradeName" : "Hostsharing eG",
    "salutation" : null,
    "title" : null,
    "givenName" : null,
    "familyName" : null
  },
  "holder" : {
    "uuid" : "7c06beef-0447-4b79-b629-40584c4d6e2e", // Person: Schäfer Elektro GmbH
    "personType" : "LEGAL_PERSON",
    "tradeName" : "Schäfer Elektro GmbH",
    "salutation" : null,
    "title" : null,
    "givenName" : null,
    "familyName" : null
  },
  "type" : "PARTNER",
  "mark" : null,
  "contact" : {
    "uuid" : "c17a94a1-8590-4291-b4fe-ba36f9c7012c", // Contact: Schäfer Elektro GmbH - Hauptkontakt (P-90004)
    "caption" : "Schäfer Elektro GmbH - Hauptkontakt (P-90004)",
    "postalAddress" : {
      "zipcode" : "44135",
      "country" : "Germany",
      "city" : "Dortmund",
      "street" : "Veilchenweg 528",
      "name" : "Buchhaltung"
    },
    "emailAddresses" : {
      "main" : "info@schaefer-elektro-gmbh.example.org"
    },
    "phoneNumbers" : {
      "office" : "+49 176 04069082"
    }
  }
} ]

UseCase Add Demo Relation => REPRESENTATIVE: Jana Schäfer - Vertretung (P-90004)

Properties

Given

name	value
partnerPersonName	Schäfer Elektro GmbH
relationType	REPRESENTATIVE
holderGivenName	Jana
holderFamilyName	Schäfer
contactCaption	Jana Schäfer - Vertretung (P-90004)
postalAddress	“street”: “Schulstraße 334”, “zipcode”: “34117”, “city”: “Kassel”, “country”: “Germany”
phoneNumber	+49 176 04069020
emailAddress	jana-schaefer@schaefer-elektro-gmbh.example.org

Person: Jana Schäfer

HTTP POST "/api/hs/office/persons" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY" \
  <<EOF
{
  "personType" : "NATURAL_PERSON",
  "familyName" : "Schäfer",
  "givenName" : "Jana"
}
EOF
=> status: 201 CREATED a51fc676-f2f5-48e1-b762-24957fb8679b

Contact: Jana Schäfer - Vertretung (P-90004)

HTTP POST "/api/hs/office/contacts" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY" \
  <<EOF
{
  "caption" : "Jana Schäfer - Vertretung (P-90004)",
  "postalAddress" : {
    "street" : "Schulstraße 334",
    "zipcode" : "34117",
    "city" : "Kassel",
    "country" : "Germany"
  },
  "phoneNumbers" : {
    "office" : "+49 176 04069020"
  },
  "emailAddresses" : {
    "main" : "jana-schaefer@schaefer-elektro-gmbh.example.org"
  }
}
EOF
=> status: 201 CREATED 85d9c7ee-d4c0-4c22-bb5a-9ab336c88eb0

Create REPRESENTATIVE: Jana Schäfer - Vertretung (P-90004)

HTTP POST "/api/hs/office/relations" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY" \
  <<EOF
{
  "type" : "REPRESENTATIVE",
  "anchor.uuid" : "7c06beef-0447-4b79-b629-40584c4d6e2e", // Person: Schäfer Elektro GmbH
  "holder.uuid" : "a51fc676-f2f5-48e1-b762-24957fb8679b", // Person: Jana Schäfer
  "contact.uuid" : "85d9c7ee-d4c0-4c22-bb5a-9ab336c88eb0" // Contact: Jana Schäfer - Vertretung (P-90004)
}
EOF
=> status: 201 CREATED 92ebfc97-51b2-4776-a8d8-5431e034cf2a

Verify the Relation Got Created

HTTP GET "/api/hs/office/relations/92ebfc97-51b2-4776-a8d8-5431e034cf2a" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY"
=> status: 200 OK 
{
  "uuid" : "92ebfc97-51b2-4776-a8d8-5431e034cf2a",
  "anchor" : {
    "uuid" : "7c06beef-0447-4b79-b629-40584c4d6e2e", // Person: Schäfer Elektro GmbH
    "personType" : "LEGAL_PERSON",
    "tradeName" : "Schäfer Elektro GmbH",
    "salutation" : null,
    "title" : null,
    "givenName" : null,
    "familyName" : null
  },
  "holder" : {
    "uuid" : "a51fc676-f2f5-48e1-b762-24957fb8679b", // Person: Jana Schäfer
    "personType" : "NATURAL_PERSON",
    "tradeName" : null,
    "salutation" : null,
    "title" : null,
    "givenName" : "Jana",
    "familyName" : "Schäfer"
  },
  "type" : "REPRESENTATIVE",
  "mark" : null,
  "contact" : {
    "uuid" : "85d9c7ee-d4c0-4c22-bb5a-9ab336c88eb0", // Contact: Jana Schäfer - Vertretung (P-90004)
    "caption" : "Jana Schäfer - Vertretung (P-90004)",
    "postalAddress" : {
      "zipcode" : "34117",
      "country" : "Germany",
      "city" : "Kassel",
      "street" : "Schulstraße 334"
    },
    "emailAddresses" : {
      "main" : "jana-schaefer@schaefer-elektro-gmbh.example.org"
    },
    "phoneNumbers" : {
      "office" : "+49 176 04069020"
    }
  }
}

UseCase Add Demo Relation => OPERATIONS: Claudia Schmitt - Technik (P-90004)

Properties

Given

name	value
partnerPersonName	Schäfer Elektro GmbH
relationType	OPERATIONS
holderGivenName	Claudia
holderFamilyName	Schmitt
contactCaption	Claudia Schmitt - Technik (P-90004)
postalAddress	“street”: “Heideweg 201”, “zipcode”: “60311”, “city”: “Frankfurt am Main”, “country”: “Germany”
phoneNumber	+49 69 90009159
emailAddress	claudia-schmitt@schaefer-elektro-gmbh.example.org

Person: Claudia Schmitt

HTTP POST "/api/hs/office/persons" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY" \
  <<EOF
{
  "personType" : "NATURAL_PERSON",
  "familyName" : "Schmitt",
  "givenName" : "Claudia"
}
EOF
=> status: 201 CREATED 65cbcf4b-a6c4-4aba-be1b-bf2b29e924c5

Contact: Claudia Schmitt - Technik (P-90004)

HTTP POST "/api/hs/office/contacts" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY" \
  <<EOF
{
  "caption" : "Claudia Schmitt - Technik (P-90004)",
  "postalAddress" : {
    "street" : "Heideweg 201",
    "zipcode" : "60311",
    "city" : "Frankfurt am Main",
    "country" : "Germany"
  },
  "phoneNumbers" : {
    "office" : "+49 69 90009159"
  },
  "emailAddresses" : {
    "main" : "claudia-schmitt@schaefer-elektro-gmbh.example.org"
  }
}
EOF
=> status: 201 CREATED b6bbf88d-c485-42d4-a939-3d8f9796d14e

Create OPERATIONS: Claudia Schmitt - Technik (P-90004)

HTTP POST "/api/hs/office/relations" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY" \
  <<EOF
{
  "type" : "OPERATIONS",
  "anchor.uuid" : "7c06beef-0447-4b79-b629-40584c4d6e2e", // Person: Schäfer Elektro GmbH
  "holder.uuid" : "65cbcf4b-a6c4-4aba-be1b-bf2b29e924c5", // Person: Claudia Schmitt
  "contact.uuid" : "b6bbf88d-c485-42d4-a939-3d8f9796d14e" // Contact: Claudia Schmitt - Technik (P-90004)
}
EOF
=> status: 201 CREATED 716746c3-54e2-4f84-99aa-db054c9f8cfc

Verify the Relation Got Created

HTTP GET "/api/hs/office/relations/716746c3-54e2-4f84-99aa-db054c9f8cfc" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY"
=> status: 200 OK 
{
  "uuid" : "716746c3-54e2-4f84-99aa-db054c9f8cfc",
  "anchor" : {
    "uuid" : "7c06beef-0447-4b79-b629-40584c4d6e2e", // Person: Schäfer Elektro GmbH
    "personType" : "LEGAL_PERSON",
    "tradeName" : "Schäfer Elektro GmbH",
    "salutation" : null,
    "title" : null,
    "givenName" : null,
    "familyName" : null
  },
  "holder" : {
    "uuid" : "65cbcf4b-a6c4-4aba-be1b-bf2b29e924c5", // Person: Claudia Schmitt
    "personType" : "NATURAL_PERSON",
    "tradeName" : null,
    "salutation" : null,
    "title" : null,
    "givenName" : "Claudia",
    "familyName" : "Schmitt"
  },
  "type" : "OPERATIONS",
  "mark" : null,
  "contact" : {
    "uuid" : "b6bbf88d-c485-42d4-a939-3d8f9796d14e", // Contact: Claudia Schmitt - Technik (P-90004)
    "caption" : "Claudia Schmitt - Technik (P-90004)",
    "postalAddress" : {
      "zipcode" : "60311",
      "country" : "Germany",
      "city" : "Frankfurt am Main",
      "street" : "Heideweg 201"
    },
    "emailAddresses" : {
      "main" : "claudia-schmitt@schaefer-elektro-gmbh.example.org"
    },
    "phoneNumbers" : {
      "office" : "+49 69 90009159"
    }
  }
}

UseCase Create Demo Debitor => Debitor: Schäfer Elektro GmbH - Rechnungsstelle (D-9000400)

Properties

Given

name	value
partnerPersonName	Schäfer Elektro GmbH
debitorNumberSuffix	00
billable	true
vatBusiness	true
defaultPrefix	aaf
bankAccountHolder	Schäfer Elektro GmbH (P-90004/0)
iban	DE18990100000374198599
bic	DEMSDEH0
billingContactCaption	Schäfer Elektro GmbH - Rechnungsstelle (D-9000400)
billingContactEmailAddress	rechnung0@schaefer-elektro-gmbh.example.org

BankAccount: Schäfer Elektro GmbH (P-90004/0)

HTTP POST "/api/hs/office/bankaccounts" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY" \
  <<EOF
{
  "holder" : "Schäfer Elektro GmbH (P-90004/0)",
  "iban" : "DE18990100000374198599",
  "bic" : "DEMSDEH0"
}
EOF
=> status: 201 CREATED 44c035a2-97c1-4b9f-9cc6-cf3fa34e75e4

Contact: Schäfer Elektro GmbH - Rechnungsstelle (D-9000400)

HTTP POST "/api/hs/office/contacts" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY" \
  <<EOF
{
  "caption" : "Schäfer Elektro GmbH - Rechnungsstelle (D-9000400)",
  "emailAddresses" : {
    "main" : "rechnung0@schaefer-elektro-gmbh.example.org"
  }
}
EOF
=> status: 201 CREATED 31fd3a91-18a5-4417-a270-d331a68e8e79

Create Debitor: Schäfer Elektro GmbH - Rechnungsstelle (D-9000400)

HTTP POST "/api/hs/office/debitors" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY" \
  <<EOF
{
  "debitorRel" : {
    "anchor.uuid" : "7c06beef-0447-4b79-b629-40584c4d6e2e", // Person: Schäfer Elektro GmbH
    "holder.uuid" : "7c06beef-0447-4b79-b629-40584c4d6e2e", // Person: Schäfer Elektro GmbH
    "contact.uuid" : "31fd3a91-18a5-4417-a270-d331a68e8e79" // Contact: Schäfer Elektro GmbH - Rechnungsstelle (D-9000400)
  },
  "debitorNumberSuffix" : "00",
  "billable" : true,
  "vatBusiness" : true,
  "vatReverseCharge" : false,
  "refundBankAccount.uuid" : "44c035a2-97c1-4b9f-9cc6-cf3fa34e75e4", // BankAccount: Schäfer Elektro GmbH (P-90004/0)
  "defaultPrefix" : "aaf"
}
EOF
=> status: 201 CREATED d1f78879-508a-483e-959c-ce14652bd680

Verify the Debitor Got Created

HTTP GET "/api/hs/office/debitors/d1f78879-508a-483e-959c-ce14652bd680" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY"
=> status: 200 OK 
{
  "uuid" : "d1f78879-508a-483e-959c-ce14652bd680",
  "debitorRel" : {
    "uuid" : "2a5e2db5-1198-402b-857e-dea50470b012",
    "anchor" : {
      "uuid" : "7c06beef-0447-4b79-b629-40584c4d6e2e", // Person: Schäfer Elektro GmbH
      "personType" : "LEGAL_PERSON",
      "tradeName" : "Schäfer Elektro GmbH",
      "salutation" : null,
      "title" : null,
      "givenName" : null,
      "familyName" : null
    },
    "holder" : {
      "uuid" : "7c06beef-0447-4b79-b629-40584c4d6e2e", // Person: Schäfer Elektro GmbH
      "personType" : "LEGAL_PERSON",
      "tradeName" : "Schäfer Elektro GmbH",
      "salutation" : null,
      "title" : null,
      "givenName" : null,
      "familyName" : null
    },
    "type" : "DEBITOR",
    "mark" : null,
    "contact" : {
      "uuid" : "31fd3a91-18a5-4417-a270-d331a68e8e79", // Contact: Schäfer Elektro GmbH - Rechnungsstelle (D-9000400)
      "caption" : "Schäfer Elektro GmbH - Rechnungsstelle (D-9000400)",
      "postalAddress" : { },
      "emailAddresses" : {
        "main" : "rechnung0@schaefer-elektro-gmbh.example.org"
      },
      "phoneNumbers" : { }
    }
  },
  "debitorNumber" : "D-9000400",
  "debitorNumberSuffix" : "00",
  "partner" : {
    "uuid" : "14e3f0a0-adae-492b-81b3-ccd3eec4fe13",
    "partnerNumber" : "P-90004",
    "partnerRel" : {
      "uuid" : "28fd0921-8a8e-4d2f-808b-1989b6c6f6a5",
      "anchor" : {
        "uuid" : "0ef98191-79d8-443e-89c1-1076e8f6df80", // Person: Hostsharing eG
        "personType" : "LEGAL_PERSON",
        "tradeName" : "Hostsharing eG",
        "salutation" : null,
        "title" : null,
        "givenName" : null,
        "familyName" : null
      },
      "holder" : {
        "uuid" : "7c06beef-0447-4b79-b629-40584c4d6e2e", // Person: Schäfer Elektro GmbH
        "personType" : "LEGAL_PERSON",
        "tradeName" : "Schäfer Elektro GmbH",
        "salutation" : null,
        "title" : null,
        "givenName" : null,
        "familyName" : null
      },
      "type" : "PARTNER",
      "mark" : null,
      "contact" : {
        "uuid" : "c17a94a1-8590-4291-b4fe-ba36f9c7012c", // Contact: Schäfer Elektro GmbH - Hauptkontakt (P-90004)
        "caption" : "Schäfer Elektro GmbH - Hauptkontakt (P-90004)",
        "postalAddress" : {
          "zipcode" : "44135",
          "country" : "Germany",
          "city" : "Dortmund",
          "street" : "Veilchenweg 528",
          "name" : "Buchhaltung"
        },
        "emailAddresses" : {
          "main" : "info@schaefer-elektro-gmbh.example.org"
        },
        "phoneNumbers" : {
          "office" : "+49 176 04069082"
        }
      }
    },
    "details" : {
      "uuid" : "4e1d814e-1424-4859-8153-1e0834d38fca",
      "registrationOffice" : "Registergericht Dortmund",
      "registrationNumber" : "619312",
      "birthName" : null,
      "birthPlace" : null,
      "birthday" : null,
      "dateOfDeath" : null
    }
  },
  "billable" : true,
  "vatId" : null,
  "vatCountryCode" : null,
  "vatBusiness" : true,
  "vatReverseCharge" : false,
  "refundBankAccount" : {
    "uuid" : "44c035a2-97c1-4b9f-9cc6-cf3fa34e75e4", // BankAccount: Schäfer Elektro GmbH (P-90004/0)
    "holder" : "Schäfer Elektro GmbH (P-90004/0)",
    "iban" : "DE18990100000374198599",
    "bic" : "DEMSDEH0"
  },
  "defaultPrefix" : "aaf"
}

UseCase Create Demo Sepa Mandate => SEPA-Mandat: D-9000400-aktuell

Properties

Given

name	value
debitorNumber	D-9000400
mandateReference	D-9000400-aktuell
bankAccountHolder	Schäfer Elektro GmbH (P-90004/0/aktuell)
iban	DE13990400000527372297
bic	DEMDDEB0
agreement	2020-07-13
validFrom	2020-07-27

Debitor of D-9000400-aktuell

HTTP GET "/api/hs/office/debitors/D-9000400" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY"
=> status: 200 OK 
{
  "uuid" : "d1f78879-508a-483e-959c-ce14652bd680",
  "debitorRel" : {
    "uuid" : "2a5e2db5-1198-402b-857e-dea50470b012",
    "anchor" : {
      "uuid" : "7c06beef-0447-4b79-b629-40584c4d6e2e", // Person: Schäfer Elektro GmbH
      "personType" : "LEGAL_PERSON",
      "tradeName" : "Schäfer Elektro GmbH",
      "salutation" : null,
      "title" : null,
      "givenName" : null,
      "familyName" : null
    },
    "holder" : {
      "uuid" : "7c06beef-0447-4b79-b629-40584c4d6e2e", // Person: Schäfer Elektro GmbH
      "personType" : "LEGAL_PERSON",
      "tradeName" : "Schäfer Elektro GmbH",
      "salutation" : null,
      "title" : null,
      "givenName" : null,
      "familyName" : null
    },
    "type" : "DEBITOR",
    "mark" : null,
    "contact" : {
      "uuid" : "31fd3a91-18a5-4417-a270-d331a68e8e79", // Contact: Schäfer Elektro GmbH - Rechnungsstelle (D-9000400)
      "caption" : "Schäfer Elektro GmbH - Rechnungsstelle (D-9000400)",
      "postalAddress" : { },
      "emailAddresses" : {
        "main" : "rechnung0@schaefer-elektro-gmbh.example.org"
      },
      "phoneNumbers" : { }
    }
  },
  "debitorNumber" : "D-9000400",
  "debitorNumberSuffix" : "00",
  "partner" : {
    "uuid" : "14e3f0a0-adae-492b-81b3-ccd3eec4fe13",
    "partnerNumber" : "P-90004",
    "partnerRel" : {
      "uuid" : "28fd0921-8a8e-4d2f-808b-1989b6c6f6a5",
      "anchor" : {
        "uuid" : "0ef98191-79d8-443e-89c1-1076e8f6df80", // Person: Hostsharing eG
        "personType" : "LEGAL_PERSON",
        "tradeName" : "Hostsharing eG",
        "salutation" : null,
        "title" : null,
        "givenName" : null,
        "familyName" : null
      },
      "holder" : {
        "uuid" : "7c06beef-0447-4b79-b629-40584c4d6e2e", // Person: Schäfer Elektro GmbH
        "personType" : "LEGAL_PERSON",
        "tradeName" : "Schäfer Elektro GmbH",
        "salutation" : null,
        "title" : null,
        "givenName" : null,
        "familyName" : null
      },
      "type" : "PARTNER",
      "mark" : null,
      "contact" : {
        "uuid" : "c17a94a1-8590-4291-b4fe-ba36f9c7012c", // Contact: Schäfer Elektro GmbH - Hauptkontakt (P-90004)
        "caption" : "Schäfer Elektro GmbH - Hauptkontakt (P-90004)",
        "postalAddress" : {
          "zipcode" : "44135",
          "country" : "Germany",
          "city" : "Dortmund",
          "street" : "Veilchenweg 528",
          "name" : "Buchhaltung"
        },
        "emailAddresses" : {
          "main" : "info@schaefer-elektro-gmbh.example.org"
        },
        "phoneNumbers" : {
          "office" : "+49 176 04069082"
        }
      }
    },
    "details" : {
      "uuid" : "4e1d814e-1424-4859-8153-1e0834d38fca",
      "registrationOffice" : "Registergericht Dortmund",
      "registrationNumber" : "619312",
      "birthName" : null,
      "birthPlace" : null,
      "birthday" : null,
      "dateOfDeath" : null
    }
  },
  "billable" : true,
  "vatId" : null,
  "vatCountryCode" : null,
  "vatBusiness" : true,
  "vatReverseCharge" : false,
  "refundBankAccount" : {
    "uuid" : "44c035a2-97c1-4b9f-9cc6-cf3fa34e75e4", // BankAccount: Schäfer Elektro GmbH (P-90004/0)
    "holder" : "Schäfer Elektro GmbH (P-90004/0)",
    "iban" : "DE18990100000374198599",
    "bic" : "DEMSDEH0"
  },
  "defaultPrefix" : "aaf"
}

BankAccount: Schäfer Elektro GmbH (P-90004/0/aktuell)

HTTP POST "/api/hs/office/bankaccounts" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY" \
  <<EOF
{
  "holder" : "Schäfer Elektro GmbH (P-90004/0/aktuell)",
  "iban" : "DE13990400000527372297",
  "bic" : "DEMDDEB0"
}
EOF
=> status: 201 CREATED de6902cc-c6b2-4370-a1a1-d4ff0c3ceffa

Create SEPA-Mandat: D-9000400-aktuell

HTTP POST "/api/hs/office/sepamandates" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY" \
  <<EOF
{
  "debitor.uuid" : "d1f78879-508a-483e-959c-ce14652bd680", // Debitor of D-9000400-aktuell
  "bankAccount.uuid" : "de6902cc-c6b2-4370-a1a1-d4ff0c3ceffa", // BankAccount: Schäfer Elektro GmbH (P-90004/0/aktuell)
  "reference" : "D-9000400-aktuell",
  "agreement" : "2020-07-13",
  "validFrom" : "2020-07-27"
}
EOF
=> status: 201 CREATED e79ce65a-c0a2-4b66-a58b-89ddc2da070d

Verify the SEPA-Mandate Got Created

HTTP GET "/api/hs/office/sepamandates/e79ce65a-c0a2-4b66-a58b-89ddc2da070d" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY"
=> status: 200 OK 
{
  "uuid" : "e79ce65a-c0a2-4b66-a58b-89ddc2da070d",
  "debitor" : {
    "uuid" : "d1f78879-508a-483e-959c-ce14652bd680", // Debitor of D-9000400-aktuell
    "debitorRel" : {
      "uuid" : "2a5e2db5-1198-402b-857e-dea50470b012",
      "anchor" : {
        "uuid" : "7c06beef-0447-4b79-b629-40584c4d6e2e", // Person: Schäfer Elektro GmbH
        "personType" : "LEGAL_PERSON",
        "tradeName" : "Schäfer Elektro GmbH",
        "salutation" : null,
        "title" : null,
        "givenName" : null,
        "familyName" : null
      },
      "holder" : {
        "uuid" : "7c06beef-0447-4b79-b629-40584c4d6e2e", // Person: Schäfer Elektro GmbH
        "personType" : "LEGAL_PERSON",
        "tradeName" : "Schäfer Elektro GmbH",
        "salutation" : null,
        "title" : null,
        "givenName" : null,
        "familyName" : null
      },
      "type" : "DEBITOR",
      "mark" : null,
      "contact" : {
        "uuid" : "31fd3a91-18a5-4417-a270-d331a68e8e79", // Contact: Schäfer Elektro GmbH - Rechnungsstelle (D-9000400)
        "caption" : "Schäfer Elektro GmbH - Rechnungsstelle (D-9000400)",
        "postalAddress" : { },
        "emailAddresses" : {
          "main" : "rechnung0@schaefer-elektro-gmbh.example.org"
        },
        "phoneNumbers" : { }
      }
    },
    "debitorNumber" : "D-9000400",
    "debitorNumberSuffix" : "00",
    "partner" : {
      "uuid" : "14e3f0a0-adae-492b-81b3-ccd3eec4fe13",
      "partnerNumber" : "P-90004",
      "partnerRel" : {
        "uuid" : "28fd0921-8a8e-4d2f-808b-1989b6c6f6a5",
        "anchor" : {
          "uuid" : "0ef98191-79d8-443e-89c1-1076e8f6df80", // Person: Hostsharing eG
          "personType" : "LEGAL_PERSON",
          "tradeName" : "Hostsharing eG",
          "salutation" : null,
          "title" : null,
          "givenName" : null,
          "familyName" : null
        },
        "holder" : {
          "uuid" : "7c06beef-0447-4b79-b629-40584c4d6e2e", // Person: Schäfer Elektro GmbH
          "personType" : "LEGAL_PERSON",
          "tradeName" : "Schäfer Elektro GmbH",
          "salutation" : null,
          "title" : null,
          "givenName" : null,
          "familyName" : null
        },
        "type" : "PARTNER",
        "mark" : null,
        "contact" : {
          "uuid" : "c17a94a1-8590-4291-b4fe-ba36f9c7012c", // Contact: Schäfer Elektro GmbH - Hauptkontakt (P-90004)
          "caption" : "Schäfer Elektro GmbH - Hauptkontakt (P-90004)",
          "postalAddress" : {
            "zipcode" : "44135",
            "country" : "Germany",
            "city" : "Dortmund",
            "street" : "Veilchenweg 528",
            "name" : "Buchhaltung"
          },
          "emailAddresses" : {
            "main" : "info@schaefer-elektro-gmbh.example.org"
          },
          "phoneNumbers" : {
            "office" : "+49 176 04069082"
          }
        }
      },
      "details" : {
        "uuid" : "4e1d814e-1424-4859-8153-1e0834d38fca",
        "registrationOffice" : "Registergericht Dortmund",
        "registrationNumber" : "619312",
        "birthName" : null,
        "birthPlace" : null,
        "birthday" : null,
        "dateOfDeath" : null
      }
    },
    "billable" : true,
    "vatId" : null,
    "vatCountryCode" : null,
    "vatBusiness" : true,
    "vatReverseCharge" : false,
    "refundBankAccount" : {
      "uuid" : "44c035a2-97c1-4b9f-9cc6-cf3fa34e75e4", // BankAccount: Schäfer Elektro GmbH (P-90004/0)
      "holder" : "Schäfer Elektro GmbH (P-90004/0)",
      "iban" : "DE18990100000374198599",
      "bic" : "DEMSDEH0"
    },
    "defaultPrefix" : "aaf"
  },
  "bankAccount" : {
    "uuid" : "de6902cc-c6b2-4370-a1a1-d4ff0c3ceffa", // BankAccount: Schäfer Elektro GmbH (P-90004/0/aktuell)
    "holder" : "Schäfer Elektro GmbH (P-90004/0/aktuell)",
    "iban" : "DE13990400000527372297",
    "bic" : "DEMDDEB0"
  },
  "reference" : "D-9000400-aktuell",
  "agreement" : "2020-07-13",
  "validFrom" : "2020-07-27",
  "validTo" : null
}

UseCase Create Membership => Membership: Schäfer Elektro GmbH

Properties

Given

name	value
partnerNumber	P-90004
validFrom	2005-01-22
membershipFeeBillable	true

Partner: P-90004

HTTP GET "/api/hs/office/partners/P-90004" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY"
=> status: 200 OK 
{
  "uuid" : "14e3f0a0-adae-492b-81b3-ccd3eec4fe13",
  "partnerNumber" : "P-90004",
  "partnerRel" : {
    "uuid" : "28fd0921-8a8e-4d2f-808b-1989b6c6f6a5",
    "anchor" : {
      "uuid" : "0ef98191-79d8-443e-89c1-1076e8f6df80", // Person: Hostsharing eG
      "personType" : "LEGAL_PERSON",
      "tradeName" : "Hostsharing eG",
      "salutation" : null,
      "title" : null,
      "givenName" : null,
      "familyName" : null
    },
    "holder" : {
      "uuid" : "7c06beef-0447-4b79-b629-40584c4d6e2e", // Person: Schäfer Elektro GmbH
      "personType" : "LEGAL_PERSON",
      "tradeName" : "Schäfer Elektro GmbH",
      "salutation" : null,
      "title" : null,
      "givenName" : null,
      "familyName" : null
    },
    "type" : "PARTNER",
    "mark" : null,
    "contact" : {
      "uuid" : "c17a94a1-8590-4291-b4fe-ba36f9c7012c", // Contact: Schäfer Elektro GmbH - Hauptkontakt (P-90004)
      "caption" : "Schäfer Elektro GmbH - Hauptkontakt (P-90004)",
      "postalAddress" : {
        "zipcode" : "44135",
        "country" : "Germany",
        "city" : "Dortmund",
        "street" : "Veilchenweg 528",
        "name" : "Buchhaltung"
      },
      "emailAddresses" : {
        "main" : "info@schaefer-elektro-gmbh.example.org"
      },
      "phoneNumbers" : {
        "office" : "+49 176 04069082"
      }
    }
  },
  "details" : {
    "uuid" : "4e1d814e-1424-4859-8153-1e0834d38fca",
    "registrationOffice" : "Registergericht Dortmund",
    "registrationNumber" : "619312",
    "birthName" : null,
    "birthPlace" : null,
    "birthday" : null,
    "dateOfDeath" : null
  }
}

The partner-number identifies the partner; a lookup by name could not, because a natural person carries its name in two columns and any name can be the prefix of a longer one.

Create Membership: Schäfer Elektro GmbH

HTTP POST "/api/hs/office/memberships" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY" \
  <<EOF
{
  "partner.uuid" : "14e3f0a0-adae-492b-81b3-ccd3eec4fe13", // Partner: P-90004
  "memberNumberSuffix" : "00",
  "status" : "ACTIVE",
  "validFrom" : "2005-01-22",
  "membershipFeeBillable" : true
}
EOF
=> status: 201 CREATED 58a33b80-bcd3-4f8a-8dcf-888a95e381dd

Verify That the Membership Got Created

HTTP GET "/api/hs/office/memberships/58a33b80-bcd3-4f8a-8dcf-888a95e381dd" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY"
=> status: 200 OK 
{
  "uuid" : "58a33b80-bcd3-4f8a-8dcf-888a95e381dd",
  "partner" : {
    "uuid" : "14e3f0a0-adae-492b-81b3-ccd3eec4fe13", // Partner: P-90004
    "partnerNumber" : "P-90004",
    "partnerRel" : {
      "uuid" : "28fd0921-8a8e-4d2f-808b-1989b6c6f6a5",
      "anchor" : {
        "uuid" : "0ef98191-79d8-443e-89c1-1076e8f6df80", // Person: Hostsharing eG
        "personType" : "LEGAL_PERSON",
        "tradeName" : "Hostsharing eG",
        "salutation" : null,
        "title" : null,
        "givenName" : null,
        "familyName" : null
      },
      "holder" : {
        "uuid" : "7c06beef-0447-4b79-b629-40584c4d6e2e", // Person: Schäfer Elektro GmbH
        "personType" : "LEGAL_PERSON",
        "tradeName" : "Schäfer Elektro GmbH",
        "salutation" : null,
        "title" : null,
        "givenName" : null,
        "familyName" : null
      },
      "type" : "PARTNER",
      "mark" : null,
      "contact" : {
        "uuid" : "c17a94a1-8590-4291-b4fe-ba36f9c7012c", // Contact: Schäfer Elektro GmbH - Hauptkontakt (P-90004)
        "caption" : "Schäfer Elektro GmbH - Hauptkontakt (P-90004)",
        "postalAddress" : {
          "zipcode" : "44135",
          "country" : "Germany",
          "city" : "Dortmund",
          "street" : "Veilchenweg 528",
          "name" : "Buchhaltung"
        },
        "emailAddresses" : {
          "main" : "info@schaefer-elektro-gmbh.example.org"
        },
        "phoneNumbers" : {
          "office" : "+49 176 04069082"
        }
      }
    },
    "details" : {
      "uuid" : "4e1d814e-1424-4859-8153-1e0834d38fca",
      "registrationOffice" : "Registergericht Dortmund",
      "registrationNumber" : "619312",
      "birthName" : null,
      "birthPlace" : null,
      "birthday" : null,
      "dateOfDeath" : null
    }
  },
  "mainDebitor" : null,
  "memberNumber" : "M-9000400",
  "memberNumberSuffix" : "00",
  "validFrom" : "2005-01-22",
  "validTo" : null,
  "status" : "ACTIVE",
  "membershipFeeBillable" : true
}

Properties

Given

name	value
transactionType	SUBSCRIPTION
memberNumber	M-9000400
reference	sign 2005-01-22
shareCount	24
comment	initial shares on joining
transactionDate	2005-01-22

Find membershipUuid

HTTP GET "/api/hs/office/memberships/M-9000400" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY"
=> status: 200 OK 
{
  "uuid" : "58a33b80-bcd3-4f8a-8dcf-888a95e381dd",
  "partner" : {
    "uuid" : "14e3f0a0-adae-492b-81b3-ccd3eec4fe13", // Partner: P-90004
    "partnerNumber" : "P-90004",
    "partnerRel" : {
      "uuid" : "28fd0921-8a8e-4d2f-808b-1989b6c6f6a5",
      "anchor" : {
        "uuid" : "0ef98191-79d8-443e-89c1-1076e8f6df80", // Person: Hostsharing eG
        "personType" : "LEGAL_PERSON",
        "tradeName" : "Hostsharing eG",
        "salutation" : null,
        "title" : null,
        "givenName" : null,
        "familyName" : null
      },
      "holder" : {
        "uuid" : "7c06beef-0447-4b79-b629-40584c4d6e2e", // Person: Schäfer Elektro GmbH
        "personType" : "LEGAL_PERSON",
        "tradeName" : "Schäfer Elektro GmbH",
        "salutation" : null,
        "title" : null,
        "givenName" : null,
        "familyName" : null
      },
      "type" : "PARTNER",
      "mark" : null,
      "contact" : {
        "uuid" : "c17a94a1-8590-4291-b4fe-ba36f9c7012c", // Contact: Schäfer Elektro GmbH - Hauptkontakt (P-90004)
        "caption" : "Schäfer Elektro GmbH - Hauptkontakt (P-90004)",
        "postalAddress" : {
          "zipcode" : "44135",
          "country" : "Germany",
          "city" : "Dortmund",
          "street" : "Veilchenweg 528",
          "name" : "Buchhaltung"
        },
        "emailAddresses" : {
          "main" : "info@schaefer-elektro-gmbh.example.org"
        },
        "phoneNumbers" : {
          "office" : "+49 176 04069082"
        }
      }
    },
    "details" : {
      "uuid" : "4e1d814e-1424-4859-8153-1e0834d38fca",
      "registrationOffice" : "Registergericht Dortmund",
      "registrationNumber" : "619312",
      "birthName" : null,
      "birthPlace" : null,
      "birthday" : null,
      "dateOfDeath" : null
    }
  },
  "mainDebitor" : null,
  "memberNumber" : "M-9000400",
  "memberNumberSuffix" : "00",
  "validFrom" : "2005-01-22",
  "validTo" : null,
  "status" : "ACTIVE",
  "membershipFeeBillable" : true
}

Create the Coop-Shares-SUBSCRIPTION Transaction

HTTP POST "/api/hs/office/coopsharestransactions" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY" \
  <<EOF
{
  "membership.uuid" : "58a33b80-bcd3-4f8a-8dcf-888a95e381dd", // membershipUuid
  "transactionType" : "SUBSCRIPTION",
  "reference" : "sign 2005-01-22",
  "shareCount" : 24,
  "comment" : "initial shares on joining",
  "valueDate" : "2005-01-22"
}
EOF
=> status: 201 CREATED 85c8156f-4388-4396-baf7-8426af7e0fbe

Verify Coop-Shares SUBSCRIPTION-Transaction

HTTP GET "/api/hs/office/coopsharestransactions/85c8156f-4388-4396-baf7-8426af7e0fbe" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY"
=> status: 200 OK 
{
  "uuid" : "85c8156f-4388-4396-baf7-8426af7e0fbe",
  "membership.uuid" : "58a33b80-bcd3-4f8a-8dcf-888a95e381dd", // membershipUuid
  "transactionType" : "SUBSCRIPTION",
  "shareCount" : 24,
  "valueDate" : "2005-01-22",
  "reference" : "sign 2005-01-22",
  "comment" : "initial shares on joining",
  "revertedShareTx" : null,
  "reversalShareTx" : null
}

Properties

Given

name	value
transactionType	DEPOSIT
memberNumber	M-9000400
reference	sign 2005-01-22
assetValue	1536
comment	deposit for initial shares
transactionDate	2005-02-06

Find membershipUuid

HTTP GET "/api/hs/office/memberships/M-9000400" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY"
=> status: 200 OK 
{
  "uuid" : "58a33b80-bcd3-4f8a-8dcf-888a95e381dd", // membershipUuid
  "partner" : {
    "uuid" : "14e3f0a0-adae-492b-81b3-ccd3eec4fe13", // Partner: P-90004
    "partnerNumber" : "P-90004",
    "partnerRel" : {
      "uuid" : "28fd0921-8a8e-4d2f-808b-1989b6c6f6a5",
      "anchor" : {
        "uuid" : "0ef98191-79d8-443e-89c1-1076e8f6df80", // Person: Hostsharing eG
        "personType" : "LEGAL_PERSON",
        "tradeName" : "Hostsharing eG",
        "salutation" : null,
        "title" : null,
        "givenName" : null,
        "familyName" : null
      },
      "holder" : {
        "uuid" : "7c06beef-0447-4b79-b629-40584c4d6e2e", // Person: Schäfer Elektro GmbH
        "personType" : "LEGAL_PERSON",
        "tradeName" : "Schäfer Elektro GmbH",
        "salutation" : null,
        "title" : null,
        "givenName" : null,
        "familyName" : null
      },
      "type" : "PARTNER",
      "mark" : null,
      "contact" : {
        "uuid" : "c17a94a1-8590-4291-b4fe-ba36f9c7012c", // Contact: Schäfer Elektro GmbH - Hauptkontakt (P-90004)
        "caption" : "Schäfer Elektro GmbH - Hauptkontakt (P-90004)",
        "postalAddress" : {
          "zipcode" : "44135",
          "country" : "Germany",
          "city" : "Dortmund",
          "street" : "Veilchenweg 528",
          "name" : "Buchhaltung"
        },
        "emailAddresses" : {
          "main" : "info@schaefer-elektro-gmbh.example.org"
        },
        "phoneNumbers" : {
          "office" : "+49 176 04069082"
        }
      }
    },
    "details" : {
      "uuid" : "4e1d814e-1424-4859-8153-1e0834d38fca",
      "registrationOffice" : "Registergericht Dortmund",
      "registrationNumber" : "619312",
      "birthName" : null,
      "birthPlace" : null,
      "birthday" : null,
      "dateOfDeath" : null
    }
  },
  "mainDebitor" : null,
  "memberNumber" : "M-9000400",
  "memberNumberSuffix" : "00",
  "validFrom" : "2005-01-22",
  "validTo" : null,
  "status" : "ACTIVE",
  "membershipFeeBillable" : true
}

Create the Coop-Assets-DEPOSIT Transaction

HTTP POST "/api/hs/office/coopassetstransactions" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY" \
  <<EOF
{
  "membership.uuid" : "58a33b80-bcd3-4f8a-8dcf-888a95e381dd", // membershipUuid
  "transactionType" : "DEPOSIT",
  "reference" : "sign 2005-01-22",
  "assetValue" : 1536,
  "comment" : "deposit for initial shares",
  "valueDate" : "2005-02-06"
}
EOF
=> status: 201 CREATED 5d49b36c-643e-4048-9557-8ec9abc9d7d7

Verify Coop-Assets DEPOSIT-Transaction

HTTP GET "/api/hs/office/coopassetstransactions/5d49b36c-643e-4048-9557-8ec9abc9d7d7" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY"
=> status: 200 OK 
{
  "uuid" : "5d49b36c-643e-4048-9557-8ec9abc9d7d7",
  "membership.uuid" : "58a33b80-bcd3-4f8a-8dcf-888a95e381dd", // membershipUuid
  "membership.memberNumber" : "M-9000400",
  "transactionType" : "DEPOSIT",
  "assetValue" : 1536,
  "valueDate" : "2005-02-06",
  "reference" : "sign 2005-01-22",
  "comment" : "deposit for initial shares",
  "adoptionAssetTx" : null,
  "transferAssetTx" : null,
  "revertedAssetTx" : null,
  "reversalAssetTx" : null
}

UseCase Add Demo Subscription => SUBSCRIBER generalversammlung: Jana Schäfer (P-90004)

Properties

Given

name	value
partnerPersonName	Schäfer Elektro GmbH
mailingList	generalversammlung
holderGivenName	Jana
holderFamilyName	Schäfer
contactCaption	Jana Schäfer - Vertretung (P-90004)

Create SUBSCRIBER generalversammlung: Jana Schäfer (P-90004)

HTTP POST "/api/hs/office/relations" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY" \
  <<EOF
{
  "type" : "SUBSCRIBER",
  "mark" : "generalversammlung",
  "anchor.uuid" : "7c06beef-0447-4b79-b629-40584c4d6e2e", // Person: Schäfer Elektro GmbH
  "holder.uuid" : "a51fc676-f2f5-48e1-b762-24957fb8679b", // Person: Jana Schäfer
  "contact.uuid" : "85d9c7ee-d4c0-4c22-bb5a-9ab336c88eb0" // Contact: Jana Schäfer - Vertretung (P-90004)
}
EOF
=> status: 201 CREATED b14b2800-3d63-4474-9019-0fd2b2bc43d6

Verify the Subscription Got Created

HTTP GET "/api/hs/office/relations/b14b2800-3d63-4474-9019-0fd2b2bc43d6" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY"
=> status: 200 OK 
{
  "uuid" : "b14b2800-3d63-4474-9019-0fd2b2bc43d6",
  "anchor" : {
    "uuid" : "7c06beef-0447-4b79-b629-40584c4d6e2e", // Person: Schäfer Elektro GmbH
    "personType" : "LEGAL_PERSON",
    "tradeName" : "Schäfer Elektro GmbH",
    "salutation" : null,
    "title" : null,
    "givenName" : null,
    "familyName" : null
  },
  "holder" : {
    "uuid" : "a51fc676-f2f5-48e1-b762-24957fb8679b", // Person: Jana Schäfer
    "personType" : "NATURAL_PERSON",
    "tradeName" : null,
    "salutation" : null,
    "title" : null,
    "givenName" : "Jana",
    "familyName" : "Schäfer"
  },
  "type" : "SUBSCRIBER",
  "mark" : "generalversammlung",
  "contact" : {
    "uuid" : "85d9c7ee-d4c0-4c22-bb5a-9ab336c88eb0", // Contact: Jana Schäfer - Vertretung (P-90004)
    "caption" : "Jana Schäfer - Vertretung (P-90004)",
    "postalAddress" : {
      "zipcode" : "34117",
      "country" : "Germany",
      "city" : "Kassel",
      "street" : "Schulstraße 334"
    },
    "emailAddresses" : {
      "main" : "jana-schaefer@schaefer-elektro-gmbh.example.org"
    },
    "phoneNumbers" : {
      "office" : "+49 176 04069020"
    }
  }
}

Contact: Jana Schäfer - private Mailinglisten-Adresse

HTTP POST "/api/hs/office/contacts" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY" \
  <<EOF
{
  "caption" : "Jana Schäfer - private Mailinglisten-Adresse",
  "postalAddress" : {
    "street" : "Mühlenkamp 757",
    "zipcode" : "44135",
    "city" : "Dortmund",
    "country" : "Germany"
  },
  "phoneNumbers" : {
    "main" : "+49 172 9973186"
  },
  "emailAddresses" : {
    "main" : "jana-schaefer@example.net"
  }
}
EOF
=> status: 201 CREATED 266ab721-8966-43d5-a51f-e8daeb1a7091

UseCase Add Demo Subscription => SUBSCRIBER members-announce: Jana Schäfer (P-90004)

Properties

Given

name	value
partnerPersonName	Schäfer Elektro GmbH
mailingList	members-announce
holderGivenName	Jana
holderFamilyName	Schäfer
contactCaption	Jana Schäfer - private Mailinglisten-Adresse

Create SUBSCRIBER members-announce: Jana Schäfer (P-90004)

HTTP POST "/api/hs/office/relations" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY" \
  <<EOF
{
  "type" : "SUBSCRIBER",
  "mark" : "members-announce",
  "anchor.uuid" : "7c06beef-0447-4b79-b629-40584c4d6e2e", // Person: Schäfer Elektro GmbH
  "holder.uuid" : "a51fc676-f2f5-48e1-b762-24957fb8679b", // Person: Jana Schäfer
  "contact.uuid" : "266ab721-8966-43d5-a51f-e8daeb1a7091" // Contact: Jana Schäfer - private Mailinglisten-Adresse
}
EOF
=> status: 201 CREATED 25536d82-29e6-49ad-a971-e0f633bcef2e

Verify the Subscription Got Created

HTTP GET "/api/hs/office/relations/25536d82-29e6-49ad-a971-e0f633bcef2e" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY"
=> status: 200 OK 
{
  "uuid" : "25536d82-29e6-49ad-a971-e0f633bcef2e",
  "anchor" : {
    "uuid" : "7c06beef-0447-4b79-b629-40584c4d6e2e", // Person: Schäfer Elektro GmbH
    "personType" : "LEGAL_PERSON",
    "tradeName" : "Schäfer Elektro GmbH",
    "salutation" : null,
    "title" : null,
    "givenName" : null,
    "familyName" : null
  },
  "holder" : {
    "uuid" : "a51fc676-f2f5-48e1-b762-24957fb8679b", // Person: Jana Schäfer
    "personType" : "NATURAL_PERSON",
    "tradeName" : null,
    "salutation" : null,
    "title" : null,
    "givenName" : "Jana",
    "familyName" : "Schäfer"
  },
  "type" : "SUBSCRIBER",
  "mark" : "members-announce",
  "contact" : {
    "uuid" : "266ab721-8966-43d5-a51f-e8daeb1a7091", // Contact: Jana Schäfer - private Mailinglisten-Adresse
    "caption" : "Jana Schäfer - private Mailinglisten-Adresse",
    "postalAddress" : {
      "zipcode" : "44135",
      "country" : "Germany",
      "city" : "Dortmund",
      "street" : "Mühlenkamp 757"
    },
    "emailAddresses" : {
      "main" : "jana-schaefer@example.net"
    },
    "phoneNumbers" : {
      "main" : "+49 172 9973186"
    }
  }
}

UseCase Add Demo Relation => OPERATIONS: Michael Fischer - Technik (P-90004)

Properties

Given

name	value
partnerPersonName	Schäfer Elektro GmbH
relationType	OPERATIONS
holderGivenName	Michael
holderFamilyName	Fischer
contactCaption	Michael Fischer - Technik (P-90004)
postalAddress	“name”: “Buchhaltung”, “street”: “Schlehenweg 867”, “zipcode”: “33602”, “city”: “Bielefeld”, “country”: “Germany”
phoneNumber	+49 176 04069045
emailAddress	michael-fischer@schaefer-elektro-gmbh.example.org

Person: Michael Fischer

HTTP POST "/api/hs/office/persons" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY" \
  <<EOF
{
  "personType" : "NATURAL_PERSON",
  "familyName" : "Fischer",
  "givenName" : "Michael"
}
EOF
=> status: 201 CREATED 3a354d7c-66c6-4ac5-babd-be0400dc3d50

Contact: Michael Fischer - Technik (P-90004)

HTTP POST "/api/hs/office/contacts" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY" \
  <<EOF
{
  "caption" : "Michael Fischer - Technik (P-90004)",
  "postalAddress" : {
    "name" : "Buchhaltung",
    "street" : "Schlehenweg 867",
    "zipcode" : "33602",
    "city" : "Bielefeld",
    "country" : "Germany"
  },
  "phoneNumbers" : {
    "office" : "+49 176 04069045"
  },
  "emailAddresses" : {
    "main" : "michael-fischer@schaefer-elektro-gmbh.example.org"
  }
}
EOF
=> status: 201 CREATED 3e61ef4e-5010-443d-b64d-34b0710eb98f

Create OPERATIONS: Michael Fischer - Technik (P-90004)

HTTP POST "/api/hs/office/relations" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY" \
  <<EOF
{
  "type" : "OPERATIONS",
  "anchor.uuid" : "7c06beef-0447-4b79-b629-40584c4d6e2e", // Person: Schäfer Elektro GmbH
  "holder.uuid" : "3a354d7c-66c6-4ac5-babd-be0400dc3d50", // Person: Michael Fischer
  "contact.uuid" : "3e61ef4e-5010-443d-b64d-34b0710eb98f" // Contact: Michael Fischer - Technik (P-90004)
}
EOF
=> status: 201 CREATED 8e82e0dd-4f4e-439f-8be5-69c8dfd48859

Verify the Relation Got Created

HTTP GET "/api/hs/office/relations/8e82e0dd-4f4e-439f-8be5-69c8dfd48859" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY"
=> status: 200 OK 
{
  "uuid" : "8e82e0dd-4f4e-439f-8be5-69c8dfd48859",
  "anchor" : {
    "uuid" : "7c06beef-0447-4b79-b629-40584c4d6e2e", // Person: Schäfer Elektro GmbH
    "personType" : "LEGAL_PERSON",
    "tradeName" : "Schäfer Elektro GmbH",
    "salutation" : null,
    "title" : null,
    "givenName" : null,
    "familyName" : null
  },
  "holder" : {
    "uuid" : "3a354d7c-66c6-4ac5-babd-be0400dc3d50", // Person: Michael Fischer
    "personType" : "NATURAL_PERSON",
    "tradeName" : null,
    "salutation" : null,
    "title" : null,
    "givenName" : "Michael",
    "familyName" : "Fischer"
  },
  "type" : "OPERATIONS",
  "mark" : null,
  "contact" : {
    "uuid" : "3e61ef4e-5010-443d-b64d-34b0710eb98f", // Contact: Michael Fischer - Technik (P-90004)
    "caption" : "Michael Fischer - Technik (P-90004)",
    "postalAddress" : {
      "zipcode" : "33602",
      "country" : "Germany",
      "city" : "Bielefeld",
      "street" : "Schlehenweg 867",
      "name" : "Buchhaltung"
    },
    "emailAddresses" : {
      "main" : "michael-fischer@schaefer-elektro-gmbh.example.org"
    },
    "phoneNumbers" : {
      "office" : "+49 176 04069045"
    }
  }
}

UseCase Add Demo Subscription => SUBSCRIBER operations-announce: Michael Fischer (P-90004)

Properties

Given

name	value
partnerPersonName	Schäfer Elektro GmbH
mailingList	operations-announce
holderGivenName	Michael
holderFamilyName	Fischer
contactCaption	Michael Fischer - Technik (P-90004)

Create SUBSCRIBER operations-announce: Michael Fischer (P-90004)

HTTP POST "/api/hs/office/relations" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY" \
  <<EOF
{
  "type" : "SUBSCRIBER",
  "mark" : "operations-announce",
  "anchor.uuid" : "7c06beef-0447-4b79-b629-40584c4d6e2e", // Person: Schäfer Elektro GmbH
  "holder.uuid" : "3a354d7c-66c6-4ac5-babd-be0400dc3d50", // Person: Michael Fischer
  "contact.uuid" : "3e61ef4e-5010-443d-b64d-34b0710eb98f" // Contact: Michael Fischer - Technik (P-90004)
}
EOF
=> status: 201 CREATED 42e8e4a4-768d-4770-940c-d3b2fc4e884f

Verify the Subscription Got Created

HTTP GET "/api/hs/office/relations/42e8e4a4-768d-4770-940c-d3b2fc4e884f" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY"
=> status: 200 OK 
{
  "uuid" : "42e8e4a4-768d-4770-940c-d3b2fc4e884f",
  "anchor" : {
    "uuid" : "7c06beef-0447-4b79-b629-40584c4d6e2e", // Person: Schäfer Elektro GmbH
    "personType" : "LEGAL_PERSON",
    "tradeName" : "Schäfer Elektro GmbH",
    "salutation" : null,
    "title" : null,
    "givenName" : null,
    "familyName" : null
  },
  "holder" : {
    "uuid" : "3a354d7c-66c6-4ac5-babd-be0400dc3d50", // Person: Michael Fischer
    "personType" : "NATURAL_PERSON",
    "tradeName" : null,
    "salutation" : null,
    "title" : null,
    "givenName" : "Michael",
    "familyName" : "Fischer"
  },
  "type" : "SUBSCRIBER",
  "mark" : "operations-announce",
  "contact" : {
    "uuid" : "3e61ef4e-5010-443d-b64d-34b0710eb98f", // Contact: Michael Fischer - Technik (P-90004)
    "caption" : "Michael Fischer - Technik (P-90004)",
    "postalAddress" : {
      "zipcode" : "33602",
      "country" : "Germany",
      "city" : "Bielefeld",
      "street" : "Schlehenweg 867",
      "name" : "Buchhaltung"
    },
    "emailAddresses" : {
      "main" : "michael-fischer@schaefer-elektro-gmbh.example.org"
    },
    "phoneNumbers" : {
      "office" : "+49 176 04069045"
    }
  }
}

UseCase Add Demo Subscription => SUBSCRIBER operations-discussion: Michael Fischer (P-90004)

Properties

Given

name	value
partnerPersonName	Schäfer Elektro GmbH
mailingList	operations-discussion
holderGivenName	Michael
holderFamilyName	Fischer
contactCaption	Michael Fischer - Technik (P-90004)

Create SUBSCRIBER operations-discussion: Michael Fischer (P-90004)

HTTP POST "/api/hs/office/relations" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY" \
  <<EOF
{
  "type" : "SUBSCRIBER",
  "mark" : "operations-discussion",
  "anchor.uuid" : "7c06beef-0447-4b79-b629-40584c4d6e2e", // Person: Schäfer Elektro GmbH
  "holder.uuid" : "3a354d7c-66c6-4ac5-babd-be0400dc3d50", // Person: Michael Fischer
  "contact.uuid" : "3e61ef4e-5010-443d-b64d-34b0710eb98f" // Contact: Michael Fischer - Technik (P-90004)
}
EOF
=> status: 201 CREATED 0363a2c9-b989-4005-9c2b-12c1d96db785

Verify the Subscription Got Created

HTTP GET "/api/hs/office/relations/0363a2c9-b989-4005-9c2b-12c1d96db785" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY"
=> status: 200 OK 
{
  "uuid" : "0363a2c9-b989-4005-9c2b-12c1d96db785",
  "anchor" : {
    "uuid" : "7c06beef-0447-4b79-b629-40584c4d6e2e", // Person: Schäfer Elektro GmbH
    "personType" : "LEGAL_PERSON",
    "tradeName" : "Schäfer Elektro GmbH",
    "salutation" : null,
    "title" : null,
    "givenName" : null,
    "familyName" : null
  },
  "holder" : {
    "uuid" : "3a354d7c-66c6-4ac5-babd-be0400dc3d50", // Person: Michael Fischer
    "personType" : "NATURAL_PERSON",
    "tradeName" : null,
    "salutation" : null,
    "title" : null,
    "givenName" : "Michael",
    "familyName" : "Fischer"
  },
  "type" : "SUBSCRIBER",
  "mark" : "operations-discussion",
  "contact" : {
    "uuid" : "3e61ef4e-5010-443d-b64d-34b0710eb98f", // Contact: Michael Fischer - Technik (P-90004)
    "caption" : "Michael Fischer - Technik (P-90004)",
    "postalAddress" : {
      "zipcode" : "33602",
      "country" : "Germany",
      "city" : "Bielefeld",
      "street" : "Schlehenweg 867",
      "name" : "Buchhaltung"
    },
    "emailAddresses" : {
      "main" : "michael-fischer@schaefer-elektro-gmbh.example.org"
    },
    "phoneNumbers" : {
      "office" : "+49 176 04069045"
    }
  }
}

Query the most recently generated demo partner

HTTP GET "/api/hs/office/relations?relationType=PARTNER&contactData=Sch%C3%A4fer+Elektro+GmbH+-+Hauptkontakt+%28P-90004%29" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY"
=> status: 200 OK 
[ {
  "uuid" : "28fd0921-8a8e-4d2f-808b-1989b6c6f6a5",
  "anchor" : {
    "uuid" : "0ef98191-79d8-443e-89c1-1076e8f6df80", // Person: Hostsharing eG
    "personType" : "LEGAL_PERSON",
    "tradeName" : "Hostsharing eG",
    "salutation" : null,
    "title" : null,
    "givenName" : null,
    "familyName" : null
  },
  "holder" : {
    "uuid" : "7c06beef-0447-4b79-b629-40584c4d6e2e", // Person: Schäfer Elektro GmbH
    "personType" : "LEGAL_PERSON",
    "tradeName" : "Schäfer Elektro GmbH",
    "salutation" : null,
    "title" : null,
    "givenName" : null,
    "familyName" : null
  },
  "type" : "PARTNER",
  "mark" : null,
  "contact" : {
    "uuid" : "c17a94a1-8590-4291-b4fe-ba36f9c7012c", // Contact: Schäfer Elektro GmbH - Hauptkontakt (P-90004)
    "caption" : "Schäfer Elektro GmbH - Hauptkontakt (P-90004)",
    "postalAddress" : {
      "zipcode" : "44135",
      "country" : "Germany",
      "city" : "Dortmund",
      "street" : "Veilchenweg 528",
      "name" : "Buchhaltung"
    },
    "emailAddresses" : {
      "main" : "info@schaefer-elektro-gmbh.example.org"
    },
    "phoneNumbers" : {
      "office" : "+49 176 04069082"
    }
  }
} ]

Verify the Showcase Cooperative Has Exactly One Membership

HTTP GET "/api/hs/office/memberships?partnerNumber=P-90000" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY"
=> status: 200 OK 
[ {
  "uuid" : "b9e8b323-4fad-42fe-b3fa-37b514bb2bf2",
  "partner" : {
    "uuid" : "905afc01-67f8-4179-9163-bc28e2ca925b", // Partner: P-90000
    "partnerNumber" : "P-90000",
    "partnerRel" : {
      "uuid" : "c956389b-4633-4988-bd9c-6b481789d174",
      "anchor" : {
        "uuid" : "0ef98191-79d8-443e-89c1-1076e8f6df80", // Person: Hostsharing eG
        "personType" : "LEGAL_PERSON",
        "tradeName" : "Hostsharing eG",
        "salutation" : null,
        "title" : null,
        "givenName" : null,
        "familyName" : null
      },
      "holder" : {
        "uuid" : "a458fd26-71ff-4145-b649-4e9146d68397", // Person: Tannenhof Bürotechnik eG
        "personType" : "LEGAL_PERSON",
        "tradeName" : "Tannenhof Bürotechnik eG",
        "salutation" : null,
        "title" : null,
        "givenName" : null,
        "familyName" : null
      },
      "type" : "PARTNER",
      "mark" : null,
      "contact" : {
        "uuid" : "6ed5d747-92ba-44bd-b43f-7c06a4ee82b5", // Contact: Tannenhof Bürotechnik eG - Hauptkontakt (P-90000)
        "caption" : "Tannenhof Bürotechnik eG - Hauptkontakt (P-90000)",
        "postalAddress" : {
          "zipcode" : "86150",
          "country" : "Germany",
          "city" : "Augsburg",
          "street" : "Am Anger 167"
        },
        "emailAddresses" : {
          "main" : "info@tannenhof-buerotechnik-eg.example.org"
        },
        "phoneNumbers" : {
          "office" : "+49 171 3920080"
        }
      }
    },
    "details" : {
      "uuid" : "4721594e-995c-4333-98d4-2f5a9bdbc5dd",
      "registrationOffice" : "Registergericht Augsburg",
      "registrationNumber" : "555465",
      "birthName" : null,
      "birthPlace" : null,
      "birthday" : null,
      "dateOfDeath" : null
    }
  },
  "mainDebitor" : null,
  "memberNumber" : "M-9000000",
  "memberNumberSuffix" : "00",
  "validFrom" : "2011-05-13",
  "validTo" : null,
  "status" : "ACTIVE",
  "membershipFeeBillable" : true
} ]

generated on 2026-08-10 03:08:44 for branch HEAD